Оценка уровня комментированности

Наиболее простой метрикой стилистики и понятности программ является оценка уровня комментированности программы F:

, (1)

где N_ком – количество комментариев в программе; N_стр - количество строк или операторов исходного текста.

Таким образом метрика F отражает насыщенность программы комментариями.

Практически, принято считать что F ≤ 0,1, т.е. на каждые десять строк программы должен приходится минимум один комментарий.

Как показываю исследования, комментарии распределяются по тексту программы неравномерно: в начале программы их избыток, а в середине или в конце – недостаток. Это объясняется тем, что в начале программы, как правило, расположены операторы описания идентификаторов, требующие более "плотного" комментирования. Такая насыщенность компенсирует недостаток комментариев в теле программы, и поэтому формула (1) недостаточно точно отражает комментированность функциональной части текста программы.

Более информативным будет вариант, когда вся программа разбивается на n равных сегментов и для каждого из них определяется F_i:

(2)

при этом (3)

Уровень комментируемости программы считается нормальным, если выполняется условие F = n. В противном случае какой либо фрагмент программы дополняется комментариями до номинального уровня.