Наличие всех параметров в комментарии экспортной процедуры (функции)

Секция Параметры описывает параметры процедуры (функции). Если их нет, секция пропускается. Предваряется строкой "Параметры:", затем с новой строки размещаются описания всех параметров.

Описание параметра начинается с новой строки, далее имя параметра, затем дефис и список типов (*), далее дефис и текстовое описание параметра. В описании параметра следует приводить сведения, дающие дополнительную информацию о типе, поясняющие назначение параметра, а также может приводиться наглядный пример с ожидаемым значением параметра.

Например, неправильно:

// Строка - Строка - строка, содержащая электронные адреса.
// МассивПеренаправленныхЗадач - Массив - массив перенаправленных задач.
// ЗадачаСсылка  - ЗадачаСсылка.ЗадачаИсполнителя - задача.

Правильно:

// Адреса - Строка - содержит электронные адреса, разделенные запятой. Например, "support@mycorp.ru, v8@localdomain".
// ПеренаправленныеЗадачи - Массив – задачи (ЗадачаСсылка.ЗадачаИсполнителя) перенаправленные другому исполнителю.
// ЗадачаИсполнителя - ЗадачаСсылка.ЗадачаИсполнителя – проверяемая задача исполнителя.

(*) Примечание: под «списком типов» подразумеваются имена типов, разделенные запятыми. Имя типа может быть простым (в одно слово) или составным - в два слова, разделенных точкой. Например: Строка, Структура, Произвольный, СправочникСсылка.Сотрудники.

Кроме того, не следует использовать в качестве типов значений несуществующие в платформе типы. В случае если в качестве типа используется более семи типов, объединенных общим критерием, следует описывать в параметре несколько наиболее распространенных типов, а в описании параметра указывать этот критерий.

Например, неправильно:

// КоллекцияСтрок - КоллекцияЗначений – коллекция для сравнения;

Правильно:

// КоллекцияСтрок – ТаблицаЗначений, Массив, СписокЗначений – Элемент для
//          сравнения. Также в качестве значения параметра могут быть указаны
//          любые другие коллекции значений, для которых доступен обход посредством оператора
//          Для каждого … Из … Цикл;

См. также

Экранирование кода

// sonar:DocumentationMissingParametersInParametersSection:off
// sonar:DocumentationMissingParametersInParametersSection:on