💚 💚 💚 Общие стандарты кодирования, которые следует соблюдать

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

В контексте этой статьи то, что мы подразумеваем под стандартами кодирования, не является официально обнародованными стандартами, установленными, скажем, для C и C++, такими как стандарты MISRA. Здесь мы имеем в виду обобщенные практики, применимые к любому языку.

Некоторые другие термины, используемые для стандартов кодирования, — это «соглашения по кодированию» или «руководства по стилю». Например, руководство по стилю JavaScript AirBnB и руководство по стилю Google.

Почему важны стандарты кодирования?

Есть два способа оценить качество программного продукта — само программное обеспечение и кодовая база, стоящая за ним.

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

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

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

Список общих стандартов кодирования, которые вы должны внедрить прямо сейчас

Структура каталогов и соглашения об именах файлов

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

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

Отступ и формат кода

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

Соглашения об именах переменных

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

Часто формат имени переменной определяется используемым языком программирования. Например, JavaScript следует формату кебаба (т. е. «iAmAVariable»), а Ruby следует формату «змеиный регистр» (т. е. «i_am_a_variable»).

Стандарты тестирования

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

Например, большинство кодовых баз значительно выигрывают от статических тестов безопасности приложений (SAST). Каждый разработчик в команде должен знать, как интегрировать SAST и на каком этапе разработки это делать, а также какой инструмент он должен установить.

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

СУХОЙ (не повторяйтесь)

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

Отказ от использования глобальных переменных (или ограничение их использования)

Глобальные переменные обычно не одобряются в сообществе программистов — по уважительным причинам. Глобальные переменные могут (и всегда будут) изменяться во время своего существования в кодовой базе. Поэтому в огромных кодовых базах легко забыть правильное значение этой переменной. Это может привести к трудно отлаживаемым программам.

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

Документация

Надлежащее документирование базы кода поможет компании и различным командам, работающим над каждым проектом, быстро увидеть важную информацию о нем, такую ​​как:

• Журналы изменений
• Проблемы (как открытые, так и решенные)
• Оставленные отзывы о проекте
• Авторы каждого изменения в коде

Удаленные репозитории, такие как Github, — лучший друг команды разработчиков программного обеспечения, поскольку они упрощают документирование базы кода.

В заключение — стандарты кодирования делают вас лучшим инженером.

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

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