Cтандарти обслуговуючого кодування

Що таке стандарти обслуговуючого кодування

Стандарт обслуговуючого кодування – набір правил та угод, які описують базові принципи оформлення програмного коду конкретною мовою.

У стандарт кодування зазвичай входять угоди про принципи іменування класів, функцій і змінних, правила форматування (наприклад, ширина відступів і символи, що використовуються для цього), стиль оформлення коментарів та умови їх використання, а також використання документуючих коментарів.

Більшість таких правил піддається автоматизації в процесі розробки коду при використанні IDE (програмної платформи для написання такого коду. Наприклад, до таких IDE відноситься кросплатформовий Visual Studio Code.

IDE може підказувати про порушення правил та автоматично форматувати написаний програмний код згідно з заданими правилами, але ще значна частина угод не піддається автоматизації і в групі розробників можуть накладатися додаткові правила та угоди.

"Будь-який дурень може написати код, зрозумілий комп'ютеру. Хороші програмісти пишуть код, зрозумілий людям".

Мартін Фаулер. Refactoring: Improving the Design of Existing Code.

Стандарти обслуговуючого кодування - запорука гарної супровідності проекту

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

Це досягається за рахунок підвищення ефективності команди розробників. Застосування набору чітко визначених стандартів кодування призводить до коду з меншою кількістю помилок, найкращою можливістю для доопрацювань та забезпечує узгодженість стилів кодування між усіма командами.

Можуть бути ситуації, коли загальний набір правил чи угод буде порушено. Такі випадки мають бути рідкісні і мати ясну і переконливу причину, зрештою схвалену командою.