Перейти к содержанию

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

Секция Возвращаемое значение должна располагаться после секции Параметры.

Пример описания функции с одним параметром:

// Определяет доступность ролей ИменаРолей текущему пользователю,
// а также доступность административных прав.
//
// Параметры:
// ИменаРолей - Строка - имена ролей, доступность которых проверяется, разделенные запятыми.
//
// Возвращаемое значение:
// Булево - Истина, если хотя бы одна из переданных ролей доступна текущему пользователю,
//          либо у него есть административные права.
//
// Пример:
// Если РолиДоступны("ИспользованиеРассылокОтчетов,ОтправкаПоПочте") Тогда ...
//

См. также

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

// sonar:DocumentationReturnValueSectionPosition:off
// sonar:DocumentationReturnValueSectionPosition:on