лого

Веб-программирование

logo
Кружковое движение

Национальная технологическая олимпиада

 

22 марта 2023 г.

Метрики качества кода: Соответствие правилам

Понятие "Метрика"

Количественный параметр, которым можно охарактеризовать качество кода называют метрикой.

В зависимости от критериев, по кокоторым определяется количественный параметр, метрики могут называться по-разному. Самой простой и понятной метрикой является метрика "Соответствие правилам".

Метрика "Соответствие правилам"

Под правилами понимают стиль и инструкции, по по которым пишется код. Целью этой метрики является максимальная прозрачность и структурированность кода для облегчения его поддержки и сопровождения.

Состав метрики

В образовательной программе "Веб-программирование" для оценки качества кода мы используем следующие правила:

Блоки

1) Разделение кода на логические блоки;
2) Разделение блоков кода, следующих друг-за другом, пустой строкой;
3) Использование табуляционных отступов для выделения вложенных блоков;

фигурные скобки блоков

1) фигурные скобки блоков открываются в конце строки, предшествующей началу блока;
2) фигурные скобки блоков закрываются на строке, следующей за строкой окончания блока

Переменные

1) переменную, относящуюся ко всей программе, объявляем в начале когда с инициализацией её начального состояния;
2) переменную, относящуюся только к конкретному блоку объявляем, внутри её блока;
3) указываем в комментариях, что переменная отслеживает/считает/хранит

Правила подсчёта метрики