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