Документ по стандартам кодирования полезен. Это наиболее полезно, когда оно достаточно короткое, чтобы каждый мог запомнить все это без особых проблем, и когда это никому не причиняет слишком много боли.
То, как вы решите сделать код в своей организации, использовать заглавные буквы, реализовать циклы или комментировать свой код, не имеет большого значения; полезная часть - заставить всех писать код, который выглядит примерно так же, как и все остальные.
- Это избавляет от необходимости тратить минуту на перекалибровку ваших ожиданий того, где должны быть скобки, и так каждый раз, когда вы смотрите на чужой код.
- Это позволяет избежать нескольких разных стилей кода в одном файле.
- Возможно, самое главное, наличие письменного стандарта позволяет избежать споров о методах кодирования во время анализа кода.
Опять же, то, что стандарты, не так важны, как наличие какого-то простого, простого стандарта. Итак, поместите всех ваших разработчиков в комнату и позвольте им спорить о том, какими должны быть стандарты. Эта встреча может продолжаться бесконечно, поэтому правила таковы:
- Все, что не решено к концу встречи, будет решать менеджер.
- Встреча заканчивается через два часа, или когда кто-то начинает кричать или плакать, в зависимости от того, что наступит раньше.
- Весь стандарт поместится (при разумном размере шрифта!) На листе или двух листах бумаги, двусторонний только в случае крайней необходимости.
Рассмотреть вопрос о принятии кого-то | еще | стандарты либо в качестве отправной точки для вашего собственного совещания по стандартам кодирования, либо как способ полностью избежать встречи.
После согласования разработчики должны иметь возможность (и следует ожидать) сами следить за этим. Случайное отклонение от стандарта не должно иметь большого значения (и может даже быть оправданным), но непреднамеренный отказ отказаться от какого-либо любимого личного стиля в пользу стандарта должен привести к немедленному перемещению в офис с протекающими водопроводными трубами или чем-то еще ,
Демиан Брехт указывает на пуховые инструменты. Это идеальное дополнение к документу по стандартам кодирования. Просто хорошо придерживаться стандартов стиля кодирования ; это важно придерживаться стандартов кодирования , которые относятся к опасной практике. Никто, кроме автора, не собирается проверять, соответствует ли каждая строка кода стандарту стиля, но вам, безусловно, следует подумать о том, чтобы встроить инструмент lint в рабочий процесс вашей команды, чтобы автоматически обнаруживать возможные ошибки. Кроме того, сам инструмент может кодифицировать принятые практики, чтобы вам не приходилось перечислять их все по отдельности в стандартах кодирования; просто укажите конфигурацию инструмента.
Примечание. Идея «стандартов кодирования» не уникальна для программирования. «Стандарты кодирования» используются во многих областях, иногда внутри организации, чаще всего в рамках всей отрасли или профессии. Несколько примеров:
В каждом случае (и во многих других) компетентный практик может легко понять «код», который не соответствует ожидаемому стандарту. Почему так много отраслей промышленности продолжают писать подробные требования к документам, которые даже не нужно анализировать компилятором? Потому что стиль имеет значение . Представление информации в стандартном стиле позволяет читателю полностью сосредоточиться на контенте, ускоряет чтение, помогает понять и уменьшает количество ошибок.