2008-11-04 1 views
17

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

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

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

Спасибо.


UPDATE: Ну, "JCL Delphi Language Style Guide", кажется явным победителем! Благодаря!

ответ

17

JCL Delphi Language Style Guide

(Расширение CodeGear в «Object Pascal Guide Style»)

http://jcl.delphi-jedi.org/documents/styleguide.html

(Спасибо, Йерун Pluimers, для заметив, что первоначальная ссылка borland.com умер, и для обеспечения новой ссылки.)

+0

В основном я придерживаюсь этого стандарта. Мое исключение состоит в том, что при размещении компонентов редактирования я обычно префикс их ed (неважно, есть ли это редактирование, заметка или поле со списком). Для кнопок I префикс с btn. – skamradt

+2

Ссылка в ответе больше не работает, но я думаю, что это ваша статья: http://jcl.delphi-jedi.org/documents/styleguide.html, с этим как хорошим дополнительным ресурсом http://jvcl.delphi-jedi.org/StyleGuide.htm –

1

JVCL-расширенной версии CodeGear в «Object Pascal Руководство Стиль»

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

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

(Выражается в Йерун Pluimers, для обеспечения новой ссылки.)

2

Econos - (. Подзаголовок «Delphi 4 Руководство разработчика стандартов кодирования документов») стандарт кодирования документа

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

+0

Ах, добрые старые мастера Ксавье Пачеко, Стив Тейшейра и Стефан Хоффмайстер! Я следил за первыми двумя, но задаюсь вопросом, что случилось со Стефаном. –

0

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

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

+0

Это очень хороший момент, и я ценю ваше создание. Благодаря! Тем не менее, мы хотим выбрать стандарт, который стремится к «полной» стороне, поэтому документ VCL может быть не лучшим. –

+0

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

0

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

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

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

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

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

Важнейшей целью должно быть создание «стандарта», который наилучшим образом служит вашей команде и вашей компании.

0

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