Наличие секции возвращаемого значения в описании экспортной функции

Секция Возвращаемое значение описывает тип и содержание возвращаемого значения функции. Для процедур эта секция отсутствует. Предваряется строкой "Возвращаемое значение:". Затем с новой строки тип возвращаемого значения, дефис и текст описания. При использовании возвращаемого значения составного типа следует каждый тип писать с новой строки и с дефиса.

Текстовое описание возвращаемого значения рекомендуется заполнять в том случае, когда только одного описания функции недостаточно, либо требуется дать дополнительную информацию о типе, например, о составе свойств или колонок возвращаемого значения.

Например:

// Возвращаемое значение:
//  Строка

// Возвращаемое значение:
//  Булево - Истина, если хотя бы одна из переданных ролей доступна текущему пользователю, либо у него есть административные права.

// Возвращаемое значение: 
//  - ЛюбаяСсылка - ссылка на предопределенный элемент.
//  - Неопределено - если предопределенный элемент есть в метаданных, но не создан в ИБ.

// Возвращаемое значение:
//  - СправочникСсылка.Пользователи
//  - СправочникСсылка.ВнешниеПользователи

Для параметров типа Массив следует указывать тип элементов с помощью ключевого слова "из" (англ. "of").

Например:

// Возвращаемое значение:
//  Массив из см. ОбновлениеИнформационнойБазы.ПараметрыОбновления

// Возвращаемое значение:
//  Массив Из Строка

Функции, возвращающие значения в виде структур и таблиц значений, должны иметь описание типа возвращаемого значения. При этом необходимо описывать свойства структур и колонки таблиц значений, начиная с новой строки и предваряя символом *.

Например:

// Возвращаемое значение:
//   ТаблицаЗначений:
//     * Серия - СправочникСсылка.СерииНоменклатуры - если серия указана и она может
//               использоваться с новым значением номенклатуры на указанном складе,
//               то возвращается переданное значение; если нет - пустая ссылка
//     * СтатусУказанияСерий - Число - если серии указываются в ТЧ "Товары", то
//               возвращается рассчитанный статус, если для переданной
//               номенклатуры/склада серии не используется - возвращается 0
//               иначе возвращается переданный статус.

// Возвращаемое значение:
//  Cтруктура:
//        * Дата – Дата
//        * Валюта - СправочникСсылка.Валюты - ссылка пересчитываемой валюты
//        * ПересчитыватьСумму - Булево

В описании структур и таблиц значений могут быть вложенные описания, при этом перед именами вложенных свойств число звездочек увеличивается: для первого уровня вложенности 2 звездочки, для второго 3 и т.д.

Например:

// Возвращаемое значение:
//  Структура:
//     * КодАдресногоОбъекта - Структура:
//        ** КодРегиона             - Число - код региона (длина - 2).
//        ** КодНаселенногоПункта   - Число - код населенного пункта (длина - 3).
//        ** КодУлицы               - Число - код улицы (длина - 4).
//     * Наименование        - Строка
//     * ОбновлениеДоступно  - Булево

Особенности

Проверка чувствительна к формату и корректно распознает документирующие комментарии, оформленные в соответствии с примерами с ИТС (приведены в текущей справке). Например, при переносе строк с описанием следует оставлять выравнивающий отступ в 10 пробелов, использовать -, * и . именно там, где они используются в примерах.

См. также

• ИТС: Описание процедур и функций
• ИТС: Структуры и таблицы значений в качестве параметров процедур и функций

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

// sonar:DocumentationReturnValue:off
// sonar:DocumentationReturnValue:on