2015-06-26
2152
4.1. Метрика уровня комментированности программ
Наиболее простой метрикой стилистики и понятности программ является оценка уровня комментированности программы F:
F=Nком/Nстр, (9)
где Nком - количество комментариев в программе;
Nстр - количество строк или операторов исходного текста.
Таким образом, метрика F отражает насыщенность программы комментариями.
Исходя из практического опыта принято считать, что F>=0.1, т. е. на каждые десять строк программы должен приходиться минимум один комментарий. Как показывают исследования, комментарии распределяются по тексту программы неравномерно: в начале программы их избыток, а в середине или в конце - недостаток. Это объясняется тем, что в начале программы, как правило, расположены операторы описания идентификаторов, требующие более "плотного" комментирования. Кроме того, в начале программы также расположены "шапки", содержащие общие сведения об исполнителе, характере, функциональном назначении программы и т. п. Такая насыщенность компенсирует недостаток комментариев в теле программы, и поэтому формула (9) недостаточно точно отражает комментированность функциональной части текста программы.
|
|
|
Более удачен вариант, когда вся программа разбивается на n равных сегментов и для каждого из них определяется Fi:
Fi = sign (Nком/Nстр - 0.1),
при этом
n
F=Сумма(Fi).
i=1
Уровень комментированности программы считается нормальным, если выполняется условие: F=n. В противном случае какой-либо фрагмент программы дополняется комментариями до номинального уровня.
4.2. Метрики корректности и интеллектуальности программ
