Отношение количества комментариев к количеству операторов
Метрика задает отношение комментариев к операторам в процентах.
Основываясь на спецификациях HIS:
Комментарии из нескольких строк считаются одним комментарием.
Например, одно замечание представляет собой следующее:
// This function implements // regular maintenance on an internal database
Комментарии, начинающиеся с линии исходного кода, не учитываются как комментарии.
Например, этот комментарий не считается комментарием для метрики, а считается как оператор:
remove(i); // Remove employee record
Оператор обычно заканчивается точкой с запятой за некоторыми исключениями. Исключения включают точек с запятой в for
циклы или объявления поля структуры.
Для образца, инициализация, условие и шаг в круглых скобках в for
цикл учитывается как один оператор. В качестве одного оператора учитывается следующее:
for(i=0; i <100; i++)
Рекомендуемый нижний предел для этой метрики составляет 20. Для лучшей читаемости вашего кода попробуйте разместить хотя бы один комментарий на каждые пять операторов.
Для обеспечения пределов на метрики:
В Polyspace® пользовательский интерфейс, см. «Вычисление метрик сложности кода».
В веб-интерфейсе Polyspace Metrics см. «Сравнение метрик с целями качества программного обеспечения».
Группа: Файл |
Акроним: COMF |
ЕГО Метрика: Да |