Какие документы стандартов кодирования Delphi вы соблюдаете?

Какие документы стандартов кодирования Delphi вы придерживаетесь?

Наша компания рассматривает возможность внедрения лучших стандартов кодирования, чтобы улучшить читаемость, обзорность и ремонтопригодность кодов. Weve сталкивается с CodeGears "Руководство по стилю Object Pascal", но он не был затронут в течение довольно долгого времени, и я думаю, что некоторые люди сделали некоторые локальные улучшения или дополнения. Я сталкиваюсь с некоторыми опубликованными вариантами и другими документами, которые перечислены ниже.

NB: Я не хочу начинать войну в стиле. Я просто хочу знать, какие стандарты вы следуете, и почему.

Спасибо.

ОБНОВЛЕНИЕ: Ну, "JCL Delphi Language Style Guide", кажется, явный победитель! Спасибо!

Ответы

Ответ 1

Руководство по стилю языка Project JEDI Delphi с дополнениями JCL

(Расширение CodeGears "Руководство по стилю Object Pascal")

https://wiki.delphi-jedi.org/wiki/Project_JEDI_Delphi_Language_Style_Guide

(Спасибо Jeroen Pluimers и AmigoJack за сообщение о том, что старые ссылки умерли. И в случае, если эта последняя ссылка также прекратит свое существование, здесь ссылка на Интернет-архив, если хотите.)

Ответ 3

Econos - Стандартный код кодирования

(подзаголовок "Документ стандартов кодирования разработчика Delphi 4" ).

http://www.econos.de/delphi/cs.html

Ответ 5

JVCL-расширенная версия CodeGears "Руководство по стилю Object Pascal"

(Это выглядит так же, как версия JCL, для меня.)

http://jvcl.delphi-jedi.org/StyleGuide.htm

(Спасибо, Jeroen Pluimers, за предоставление новой ссылки.)

Ответ 6

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

Тем не менее, почему бы не выбрать тот же стандарт, что и ваша библиотека времени выполнения (VCL) и использование документации? Тогда вы все будете говорить на одном диалекте, и вам будет легче читать код библиотеки времени исполнения. И есть много примеров кода, чтобы проиллюстрировать соглашения о кодировании.

Ответ 7

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

Я согласен с комментарием Jozzs. Вы можете посмотреть все рекомендуемые стандарты, выбрать один и заставить его на своих кодах, или вы можете вовлечь свою команду в процесс.

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

Итак, взгляните на существующие варианты кодирования и соберете команду для некоторых динамичных обсуждений:

  • Причины принятия стандарта кодирования.
  • Основные аспекты стандартизации.
  • Настраивать любые неуверенности в команде вокруг этой проблемы.
  • Нахождение точки согласия. Что важно, а что нет.
  • Установление некоторых корпоративных целей, чтобы каждый чувствовал, что они работают над достижением общей цели.
  • Получить команду, чтобы продать преимущества стандартизации для себя.

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

Ответ 8

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

Ответ 9

CodeGears "Венгерское арахисовое масло", для идентификации идентификаторов

http://dn.codegear.com/article/27983