Cтандарты обслуживающего кодирования

Что такое стандарты обслуживающего кодирования

Стан­дарт обслуживающего коди­ро­ва­ния — набор пра­вил и согла­ше­ний, кото­рые опи­сы­вают базо­вые прин­ципы оформ­ле­ния про­грамм­ного кода на конкретном языке.

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

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

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

"Любой дурак может написать код, понятный компьютеру. Хорошие программисты пишут код, понятный людям".

Мартин Фаулер. Рефакторинг: Улучшение дизайна существующего кода.

Стандарты обслуживающего кодирования — залог хорошей сопровождаемости проекта

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

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

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