Переменные должны содержать описание

Имена переменных назначаются согласно общим правилам образования имен переменных.

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

Подозрительный код

Перем КоличествоТаблиц;

Правильный код

Перем КоличествоТаблиц; // количество таблиц, необходимых для решения задачи

См. также

• ИТС: Структура модуля
• ИТС: Описание процедур и функций
• ИТС: Использование переменных в программных модулях
• Правило: Экспортные переменные должны содержать описание
• Правило: Экспортные процедуры/функции должны содержать описание

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

// sonar:VariableWithoutDescription:off
// sonar:VariableWithoutDescription:on