Skip to content

Commit

Permalink
Еще дока
Browse files Browse the repository at this point in the history
  • Loading branch information
nixel2007 committed Nov 18, 2024
1 parent b9b4ca4 commit 8bdf122
Show file tree
Hide file tree
Showing 8 changed files with 68 additions and 3 deletions.
21 changes: 21 additions & 0 deletions src/internal/Классы/АннотацияДуб.os
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
// Помечает указанный класс как фабрику компонентов - дуб, из которого появляются желуди.

Check warning on line 1 in src/internal/Классы/АннотацияДуб.os

View check run for this annotation

sonar.openbsl.ru qa-bot / autumn Sonarqube Results

src/internal/Классы/АннотацияДуб.os#L1

Программные модули не должны иметь закомментированных фрагментов кода
// `&Дуб` сам по себе тоже является желудем, то есть может запрашивать прилепление частиц,
// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
//
// Дуб содержит методы, помеченные аннотацией `&Завязь`, которые возвращают желуди.
//
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
// как оно возвращается функцией `ТипЗнч`.
// Пример:
// &Дуб
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
// .
// &Завязь
// Функция ПользовательскийЖелудь() Экспорт
// . Возврат Новый ПользовательскийЖелудь();
// КонецФункции
//
&Аннотация("Дуб")
Процедура ПриСозданииОбъекта(Значение = "")

Expand Down
9 changes: 7 additions & 2 deletions src/internal/Классы/АннотацияЖелудь.os
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,13 @@
// Размещается над конструктором класса.
//
// Параметры:
// Значение - Строка- Имя желудя. По умолчанию будет использовано имя типа объекта,
// как оно возвращается функцией `ТипЗнч`.
// Значение - Строка - Имя желудя. По умолчанию будет использовано имя типа объекта,
// как оно возвращается функцией `ТипЗнч`.
//
// Пример:
// &Желудь
// Процедура ПриСозданииОбъекта()
// КонецПроцедуры
//
&Аннотация("Желудь")
Процедура ПриСозданииОбъекта(Значение = "")
Expand Down
18 changes: 18 additions & 0 deletions src/internal/Классы/АннотацияЗавязь.os
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
// Помечает функцию как функцию, создающую желудь.

Check warning on line 1 in src/internal/Классы/АннотацияЗавязь.os

View check run for this annotation

sonar.openbsl.ru qa-bot / autumn Sonarqube Results

src/internal/Классы/АннотацияЗавязь.os#L1

Программные модули не должны иметь закомментированных фрагментов кода
//
// Может иметь параметры, каждый из которых должен быть промаркирован как &Пластилин, &Деталька или &Блестяшка.
// В указанные параметры автоматически будут прилеплены соответствующие частицы при создании желудя.
//
// Размещается над экспортной функцией в классе, проаннотированном как `&Дуб`.
//
// Параметры:
// Значение - Строка - Имя создаваемого желудя. По умолчанию будет использовано имя метода.
// Тип - Строка - Тип создаваемого желудя.
// Требуется если по имени желудя не получается однозначного определить его тип.
//
// Пример:
// &Завязь
// Функция ПользовательскийЖелудь(&Пластилин Зависимость, &Деталька ВажнаяНастройка) Экспорт
// . Возврат Новый ПользовательскийЖелудь(Зависимость, ВажнаяНастройка);
// КонецФункции
//
&Аннотация("Завязь")
Процедура ПриСозданииОбъекта(Значение = "", Тип = "")

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@
Перем _ПрименятьТолькоНапильники;
Перем _НеПрименятьНапильники;

// Проверяет, может ли указанный напильник применяться над желудем, помеченным аннотацией `&ОсобоеОбращение`.
//
// Параметры:
// ИмяНапильника - Строка - Имя напильника для проверки применимости.
//
// Возвращаемое значение:
// Булево - Истина, если напильник может применяться на текущем желуде, иначе Ложь.
//
Функция НапильникМожетПрименяться(ИмяНапильника) Экспорт

Если _ОтключитьВсеНапильники Тогда
Expand All @@ -24,6 +32,8 @@
// применение конкретных напильников или отключение конкретных напильников. Если задано ограничение на применение только
// конкретных напильников, то нельзя задавать ограничение на отключение конкретных напильников (и наоборот).
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// ОтключитьВсеНапильники - Булево - Не применять на желуде никакие напильники.
// ПрименятьТолькоНапильник - Строка - Повторяемый параметр. Применять на желуде только напильник с указанным именем.
Expand Down
2 changes: 2 additions & 0 deletions src/internal/Классы/АннотацияПриемка.os
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
//
// Каждая `&Приемка` так же имеет `&Характер("Компанейский")`, `&Прозвище("Приемка")` и `&Спецификация("Инициализация")`
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Имя желудя, под которым приемка добавляется в контекст Поделки.
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
//
// Может быть использовано, например, для группировки желудей и получении их в виде массива.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Задаваемое прозвище.
//
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,16 @@

// Специальный тип желудя, автоматически выполняемый при запуске приложения (`Поделка.ЗапуститьПриложение()`).
//
// Класс, помеченный аннотацией `&Рогатка`, должен реализовать следующий интерфейс:
// Желудь, помеченный аннотацией `&Рогатка`, должен реализовать следующий интерфейс:
// * `Процедура ПриЗапускеПриложения() Экспорт`
//
// Каждая `&Рогатка` дополнительно имеет `&Прозвище("Рогатка")`.
//
// `&Рогатка` сама по себе тоже является желудем, то есть может запрашивать прилепление частиц,
// является объектом для обработки `&Напильник`ом, может иметь `&Спецификация` и так далее.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Имя желудя, под которым рогатка добавляется в контекст Поделки.
// ЗапускатьВФоне - Булево - Если Истина, то рогатка будет запущена в фоновом задании.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
//
// К желудям со специкацией "Инициализация" не применяются напильники.
//
// Размещается над конструктором класса или над методом `&Завязи`.
//
// Параметры:
// Значение - Строка - Состояние приложения, на котором разрешено создавать желудь. См. СостоянияПриложения.
//
Expand Down

0 comments on commit 8bdf122

Please sign in to comment.