Я составляю правила программирования для моей команды: каковы ваши? - PullRequest
44 голосов
/ 05 февраля 2009

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

Для этого я хотел создать список вещей, которые:

  • лучшая практика,
  • лучшая мысль,
  • лучший подход ...

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

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

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

Начну с первого.

СУХОЙ - Не повторяйся - В коде, комментариях или документации.

Ответы [ 65 ]

9 голосов
/ 05 февраля 2009

Это то, что ты говоришь, и то, как ты это говоришь

Нет смысла иметь отличные идеи, если вы не доносите их эффективно.

через Прагматичный программист

9 голосов
/ 05 февраля 2009

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

От: Код ужаса

7 голосов
/ 05 февраля 2009

Build Breaker покупает обед

7 голосов
/ 05 февраля 2009

Построить это правильно первым. Сделай это быстро второй.

7 голосов
/ 05 февраля 2009

Публикация рано, публикация часто

7 голосов
/ 06 февраля 2009

Часто проводят проверки кода

Проверка кода и, следовательно, рефакторинг - это постоянная задача. Вот несколько приятностей о проверке кода на мой взгляд:

  1. Улучшает качество кода.
  2. Помогает преобразовать повторно используемые коды в библиотеки многократного использования.
  3. Это поможет вам учиться у ваших коллег-разработчиков.
  4. Это поможет вам учиться на своих ошибках и освежить вашу память о гениальном коде, который вы написали раньше.
6 голосов
/ 05 февраля 2009

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

5 голосов
/ 05 февраля 2009

Примите участие в разработке с открытым исходным кодом

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

5 голосов
/ 05 февраля 2009

Понимание инструментов, которые вы используете

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

5 голосов
/ 05 февраля 2009

Соглашение о конфигурации

Особенно там, где условности сильны, и можно пожертвовать некоторой гибкостью.

...