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

Question

Что вы считаете лучшим способом опубликовать ваши стандарты кодирования и почему?

Answer 1

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

Answer 2

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

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

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

---

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

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

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

Answer 3

Если вы используете Eclipse, вы можете использовать средства форматирования (Preferences-> Java-> Code Style-> Formatters) для автоматического форматирования кода при сохранении исходного файла. У нас просто есть форматер нашей компании, доступный в нашей вики, и каждый импортирует его в Eclipse.

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

Answer 4

Руководство по кодам - ​​это документ, который описывает всю компанию. И это доступно и должно строго соблюдаться.

Стандарт форматирования кода зависит от членов команды (или проекта). Для нашего проекта он хранится в SVN как набор настроек для плагина Resharper .

Answer 5

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

• Вики-страницы со стандартами и примерами
• Стандартные инструменты автоматической кодировки, работающие во время процесса CI

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

Answer 6

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

UPDATE:

Несколько лет спустя Документы Google стали своего рода вики.

Answer 7

Наш проект в основном на python, поэтому мы в основном взяли Руководство по кодированию Python , кое-что изменили, что нам не понравилось, и прикрепили их к нашему Trac вики. Он связан прямо на первой странице, чтобы разработчики знали, где его найти. До сих пор он действительно проделал довольно достойную работу, следуя за ним!

Answer 8

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

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

Answer 9

Собственный веб-сайт с SVN, используемый для управления изменениями. «Последние» всегда доступны для команды онлайн.

Answer 10

Когда я управлял небольшой командой, нашими «стандартами кодирования» был сценарий-обертка для CVS, который запускал отступ (с помощью командного файла для всей команды) для вашего кода, когда вы его регистрировали.