Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Докуметация по API #109

Merged
merged 10 commits into from
Nov 19, 2024
Merged

Докуметация по API #109

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
26b65b1
Документация по прилепляемым частицам
nixel2007 Nov 2, 2024
3364d4e
Some docs
nixel2007 Nov 11, 2024
6308eae
Еще немного документации
nixel2007 Nov 14, 2024
9418452
Еще дока
nixel2007 Nov 15, 2024
a2db9d2
Еще дока
nixel2007 Nov 15, 2024
b9b4ca4
Еще дока
nixel2007 Nov 16, 2024
8bdf122
Еще дока
nixel2007 Nov 18, 2024
7a44094
И еще
nixel2007 Nov 18, 2024
52f52ed
И еще
nixel2007 Nov 18, 2024
ebe5006
Apply code review suggestions
nixel2007 Nov 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/internal/Классы/АннотацияБлестяшка.os
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
// Маркерная аннотация для указания, что прилепляемая частица
// является произвольным значением, передавамым кодом.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Передаваемым в конструктор жёлудя вероятно (да у завязи это формально метод а не конструктор, но метод завязи суть конструктор жёлудя)

//
// Может быть использована только над параметром конструктора/метода завязи желудя.
//
&Аннотация("Блестяшка")
Процедура ПриСозданииОбъекта()

Expand Down
13 changes: 13 additions & 0 deletions src/internal/Классы/АннотацияДеталька.os
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
// Маркерная аннотация для указания, что прилепляемая частица
// является настройкой приложения.
//
// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
// или методом установки значения.
//
// Параметры:
// Значение - Строка - Ключ настройки. См. библиотеку [configor](https://github.com/oscript-library/configor)
// для полного описания синтаксиса.
// Если не заполнено, используется имя параметра конструктора/поля класса
// или часть имени метода для установки значения.
// ЗначениеПоУмолчанию - Произвольный - Значение, которое принимает деталька, если не задано из-вне.
//
&Аннотация("Деталька")
Процедура ПриСозданииОбъекта(Значение = "", ЗначениеПоУмолчанию = Неопределено)

Expand Down
14 changes: 14 additions & 0 deletions src/internal/Классы/АннотацияПластилин.os
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
// Маркерная аннотация для указания, что прилепляемая частица
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Мне кажется описание не внесло никакой ясности, стоит я думаю сразу ноэа входе описать что это маркер который загрузит в поле/параметр жёлудь зарегистрированный в системе типов осени, или что-то типа того вероятно

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Я тут использовал термин "прилепление частиц", который есть в документации, но которого нет в API в явном виде (исключая модуль с типами прилепляемых частиц и класса ПрилепляторЧастиц). Если уж расписывать, то расписывать и здесь, и в детальке, и в блестяшке. Либо описывать термин где-то отдельно, "ссылаясь" на него.

// является желудем. Основной способ связывания желудей между собой.
//
// Может быть использована над параметром конструктора/метода завязи желудя, полем класса
// или методом установки значения.
//
// Параметры:
// Значение - Строка - Имя внедряемого желудя. Если не заполнено, используется имя параметра конструктора/поля класса
// или часть имени метода для установки значения.
// Тип - Строка - Тип внедряемого желудя. В случае передачи значения "Желудь", будет внедрен желудь как таковой.
// Так же может быть указан тип "Массив", "ТаблицаЗначений" и другие. Полный список доступных типов
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Так же может быть указан тип-коллекция

// см. в библиотеке [autumn-collections](https://github.com/autumn-library/autumn-collections).
// Блестяшка - Произвольный - Повторяемый параметр. Передаваемые в прилепляемый желудь произвольные значения.
//
&Аннотация("Пластилин")
Процедура ПриСозданииОбъекта(Значение = "", Тип = "", &Повторяемый Блестяшка = Неопределено)

Expand Down
Loading