Процедуры и функции программного интерфейса должны иметь описание

Описание процедур и функций рекомендуется выполнять в виде комментария к ним. Необходимость комментирования отдельных участков кода процедур и функций должна определяться разработчиком исходя из сложности и нестандартности конкретного участка кода.

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

Прочие процедуры и функции рекомендуется комментировать, если требуется пояснить назначение процедуры (функции) или особенности её работы. Также рекомендуется описывать причины невыполнения некоторых действий, если они кажутся неочевидными для данной процедуры или функции.

Особенности:

Параметр Проверять наличие описаний во всех экспортных процедурах и функциях (без учета областей) включает проверку наличия описаний у всех экспортных процедур и функций модулей, в том числе процедур и функций, не включенных ни в одну область. По умолчанию параметр отключен (false).
Параметр Имена областей модуля, в которых обязательны описания экспортных процедур позволяет указать список имен областей модулей, в которых обязательно комментирование процедур и функций (т.е. областей, входящих в программный интерфейс модулей).

См. также

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

// sonar:UndocumentedPublicApi:off
// sonar:UndocumentedPublicApi:on