Предварительные замечания

Замечания по кодированию

  • При именовании переменных не используйте понятные только узкому кругу лиц сокращения и аббревиатуры.
  • Используйте интерфейсы
  • Используйте пространства имен
  • Вместо магических чисел используйте перечисления
  • Обрабатывайте только известные вам исключения.
  • Старайтесь избегать файлов с более чем 1000 строками кода.
  • Старайтесь избегать методов с более чем 3-4 экранами кода.
  • Избегайте методов с более чем 5 параметрами.

Замечания по тестированию и сопровождению

Замечания по версионному контролю

  • Используйте ветки «стабильная» и «разрабатываемая». См. например http://svnbook.red-bean.com/nightly/ru/svn.branchmerge.html и http://habrahabr.ru/blogs/development_tools/45203/
  • В стабильной ветке должна находиться последняя рабочая версия разрабатываемого приложения.
  • Каждая версия как в стабильной ветке, так и в разрабатываемой должна успешно собираться, проходить тесты и запускаться.
  • Пишите комментарии к комитам, в которых должно быть четко в 1-2 предложения описано, какие изменения произведены. Более подробную информацию об изменениях храните отдельно в вики.
  • Соблюдайте принцип – «один комит – одно функциональное изменение». Не смешивайте в одном комите, например, исправление бага и добавление кнопки на интерфейс, пусть это будут два разных комита.

Концептуальные замечания

  • Помните - код чаще читается, чем пишется.
  • Старайтесь делать программные модули как можно более инкапсулированными
  • Следуйте принципу KISS
  • Разбивайте задачу на подзадачи
  • "Замораживайте" проект на заключительной перед релизом стадии. Т.е. в последнее время перед сдачей проекта не допускайте перепроектирования, переписывания и т.д.

Last edited Jan 19, 2012 at 11:49 AM by basph, version 18

Comments

No comments yet.