Метрики стилистики и понятности программ

ЦЕЛЬ РАБОТЫ: оценить качество программных продуктов с точки зрения их стилистики и понятности.

 

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

 

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

, (1)

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

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

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

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

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

(2)

при этом (3)

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

 

Метрики Холседа для оценки стилистики

И понятности программ

Следующие характеристики являются продолжением метрики Холседа. Стилистика и понятность программ тесно связаны и с размером, и со сложностью программ.

Для измерения теоретической длины программы М.Холстед вводит аппроксимирующую формулу:

, (4)

где η₁ – словарь операторов; η₂ – словарь операндов программы.

Вводя эту оценку, Холстед исходит из основных концепций теории информации, по аналогии с которыми частота использования операторов и операндов в программе пропорционально двоичному логарифму количества их типов. Таким образом, выражение (4) справедливо для потенциально корректных программ, свободных от избыточности или несовершенств (стилистических ошибок).

Несовершенствами можно считать следующие ситуации:

а) последующая операция уничтожает результаты предыдущей без их использования;

б) присутствуют тождественные выражения, решающие совершенно одинаковые задачи;

в) одной и той же переменной назначаются различные имена и т.п.

Подобные ситуации приводят к изменению N, без изменения η.

Для стилистически корректных программ отклонение в оценке теоретической длины от реальной N не превышает 10 %. Таким образом, измеряя η_1, η_2, N₁ и N₂ и сопоставляя значения N и для некоторой программы, можно говорить о наличии в программе стилистических ошибок, т.е. несовершенств.