Как Вы документируете свои стандарты кодирования? [закрытый]

Я делаю все, чтобы помочь запросить всех:

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

У нас в настоящее время есть стандарт кодирования в Wiki, которую только сэр Developers имеет права отредактировать. Однако как многие люди уже указали, никто не читает его после их первых нескольких дней. Мы в настоящее время находимся в процессе попытки получить наш стандарт кодирования в StyleCop на стороне.NET. Материал Delphi немного более тверд, так как у нас нет платформы Delphi как StyleCop для использования.

При использовании Eclipse можно использовать средства форматирования (Предпочтения-> Java-> Стиль кода-> Средства форматирования) для автоматического форматирования код, когда исходный файл сохраняется. Мы просто имеем средство форматирования нашей компании в наличии на нашей Wiki, и все импортируют его в Eclipse.

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

Это зависит от обстоятельств:

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

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

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

• безопасность и правительственные ограничения
• потребности и исходные данные от отдела
• QA, если существует все еще свобода выбора: вход от разработчиков

Этот стандарт кодирования записан и осуществляется QA.

Мы переместились из документов Word, которые оказались громоздкими и склонными для становления устаревшими к

• страницы Wiki со стандартами и примерами
• инструменты проверки стандарта Автоматического кодирования, работающие во время процесса CI

N.B. , Также у нас есть клиент, который не использует, выполняет что-либо кроме самой сборки в цикле CI. Они сохраняют свои правила в ReSharper и вполне довольны результатами

Когда я управлял малочисленной командой, наши "стандарты кодирования" был сценарий обертки на CVS, который выполнил отступ (с емкостно-резистивным файлом всей команды) на Вашем коде, когда Вы регистрировали его.

Я документирую стандарт кода:

• структура от самого важного общего стиля (как добавление отступа, обертывание строки, фигурные скобки...)
• к менее видимым деталям (пространство прежде/после того, как ( или ))
• примеры кода
• описания установки для конфигурирования затмения кодируют прозу средства форматирования

Внутренний веб-сайт с SVN привык для управления работами изменений. 'Последнее' всегда доступно команде онлайн.

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

ОБНОВЛЕНИЕ:

Несколько лет на, и Google Docs теперь служит своего рода Wiki.

Мы сделали следующее для документирования наших стандартов кодирования:

1. Записал их в простом файле слова. Основой для этого styleguide был Sun, Кодирующий Конвенции.
2. Настроенный Checkstyle и PMD для следования этим конвенциям кодирования, дополнительно обеспечил рабочую область по умолчанию для Eclipse, который имел правильную конфигурацию, которая соответствует к определенным конфигурациям Checkstyle и PMD.
3. Добавленный три главы к нашим конвенциям кодирования, которые объяснили, что Checkstyle, PMD и конфигурация Eclipse, выполненная, который часть styleguide, так, чтобы каждый архитектор мог изменить styleguide и конфигурации Checkstyle, PMD и Eclipse.
4. Разработанные небольшие плагины так, чтобы путем установки Checkstyle и PMD вместе с нашими плагинами, наша конвенция кодирования, определенная Checkstyle и PMD, была значением по умолчанию и легкий выбрать.

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

Инструкции по коду являются общекорпоративным описанием документа методы. И это доступно и должно вполне строго сопровождаться.

стандарт форматирования Кода подвергается для решения между командой (или проект) участников. Для нашего проекта это сохранено в SVN как ряд настроек для плагин Resharper.

Мы используем следующее:

1. Инструменты/плагины в редакторе (checkstyle, pmd, внутренние инструменты)
2. проверки Времени изготовления представляют отчет.
3. Wiki привыкла к комментариям обзора кода документа
4. От 3, мы тогда осуществляем рефакторинг 'toolable' во внутренний инструмент.

Whenver я был ответственен за устанавливание нормы кодирования, я пытаюсь найти хороший в Интернете, который удовлетворяет нашим потребностям и использует это. Я возьму любой формат, он входит, обычно PDF или Word.

нет никакого смысла изобретения велосипед - я могу также усилить тяжелую работу, которую кто-то еще сделал.

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

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

, Вы могли также установить страницу Wiki.

Мы помещаем его на Wiki со ссылками на фрагменты кода, где это полезно.

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

Если Вы разрабатываете в.NET. Я рекомендовал бы использовать StyleCop для проверки сборок. Я также рекомендовал бы использовать ReSharper и плагин StyleCop.

С ReSharper и плагином StyleCop Вы получаете красные "волнистые" строки под кодом, который является против стандарта, и простая законченная мышь объяснит почему. Никакие обзоры кода, никакие документы maintian.

Используя StyleCop в Вашем процессе сборки гарантирует, что весь код, в котором зарегистрировались, соответствует стандартам.

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

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

Путешествуют налегке!

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

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

Наш проект находится главным образом в Python, таким образом, мы в основном взяли , Python, Кодирующий Инструкции , изменил что-то тут и там, что мы не любили и выставили их на нашем Trac wiki. Это связалось прямо на первой полосе так, чтобы devs знали, где найти его. До сих пор это на самом деле сделало довольно достойное задание того, чтобы быть сопровождаемым!