Соглашение о кодировании

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

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

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

Примеры правил кодирования.

Наш опыт.

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