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

| 2 Comments

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

За свой недолгий трудовой стаж я поработал в трех компаниях, в одной из которых существовало руководство по стилю кодирования. Оно охватывало несколько языков: C, PHP, Perl, JavaScript, CSS, SQL. То есть те языки, которые там использовались. Помню, первое время мне было крайне тяжело следовать всем правилам этого руководства, потому что я пришел в компанию уже с существующим багажом опыта. Не со всеми правилами я изначально был согласен, некоторые считаю до сих пор не совсем уместными, но что важно, все проекты в компании следовали этим самым правилам. По этой причине читать чужой код было довольно легко, будто ты сам его писал. В руководстве говорилось, какие отступы использовать, как надо называть классы и переменные, как расставлять скобки и каким образом форматировать условные выражения. Разумеется, это далеко не все, что покрывало то руководство, оно содержало, наверное, не меньше ста страниц и могло бы потянуть на небольшую книгу.

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

За последние пару лет я прочитал несколько книг и статей, которые тем или иным образом связаны со стилем кодирования, пару из них я приведу чуть ниже. В целом, все книги, нацеленные на профессиональных разработчиков вне зависимости от языка программирования, говорят о том, как важно выбрать (или выработать) определенный стиль и после этого неуклонно ему следовать. Что важнее, вся команда должна придерживаться этого свода правил. Обычно это и самое тяжелое — заставить всех программистов работать в едином стиле. Советуется собраться всей командой и не торопясь зафиксировать на бумаге (я подразумеваю, какой либо документ — на бумаге или электронный) все выработанные правила. Делать это совместно необходимо для того, чтобы устранить все разногласия именно на этапе формирования правил, иначе кто-то обязательно откажется следовать им, так как посчитает их бесполезными или необоснованными. Мне также понравилась идея, изложенная в статье “Why Coding Style Matters”, набирать команду, которая изначально следует одному и тому же стилю. Разумеется, это не отменяет необходимости зафиксировать все документально (например, для новых сотрудников), но позволяет сделать это легко и быстро. Сам я еще ни разу не занимался наймом программистов, но уверен, что буду следовать именно такому пути.

В заключение, как и обещал, несколько ссылок.

2 Comments

  1. Здравствуйте на вашем сайте pastecode.ru не работает вставка правильно. Ошибка в JS

Leave a Reply

Required fields are marked *.