1 заметка с тегом

стиль кодирования

Порядок и беспорядок в коде

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

Любой популярный фреймворк использует или общепринятые во всём мире (напр., в ПХП есть ПСР) или свои персональные стандарты (так бывает, тут уж ничего не поделаешь).

Нет ничего хуже, когда в проекте образуется зоопарк стилей написания кода. Ситуация: Вася пишет согласно ПСР, Петя применяет код-стайл «Вордпресса», а у Саши и вовсе своё чувство прекрасного. В итоге получаем полный зоопарк, сбивающий с толку любого, заглянувшего под капот проекта, программиста.

Если вы сомневаетесь в моём утверждении, подумайте, что было бы, перестань издательства оформлять свою печать по типографским стандартам? Да вы замучились бы читать книгу, встречая очередной абзац с новым оформлением. То же самое с кодом — и вы, и ваши коллеги, и разработчики, в руки которых в будущем перейдёт проект — его будут читать как книгу изо дня в день.

Ещё одна распространённая проблема код-стайла — комментарии в коде. Они всегда должны быть на языке, де факто являющимся основным в программировании — английском. Выбор любого другого языка для комментариев повлечёт за собой возникновение всё того же зоопарка: рано или поздно в проекте начнут использоваться сторонние библиотеки, оформленные должным образом.

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

2015   программирование   стиль кодирования