Оформляем код правильно - и радуемся результату!

Несколько основных рекомендаций по поводу того, как красиво оформить код
25 ноября 2015326451Илья Бубнов44501429

Давайте сразу вскроем карты. Я не программист, у меня нет соответствующего образования, у меня нет десятка лет опыта работы в этой области, я даже не умею печатать текст, не глядя на клавиатуру. Тем не менее, я наделён умением складывать символы в код ПО, которое иногда, вы не поверите, даже работает. И вот однажды, подготавливая своё творчество к процедурам сертификации и лицензирования, я наткнулся на стандарты в области оформления. И подумал, как было бы здорово, если бы все программисты, даже начинающие, писали правильно! Дело за малым – побудить к этому ещё немного людей в этом кратком руководстве.

1. Придерживайтесь общепринятых стандартов обозначения. Это основы, которую рассказывают (или по крайней мере должны) ещё в школе на первых уроках программирования: 

  • Никогда и ни при каких обстоятельствах не присваивайте выходным переменным непонятные названия, вроде «Сумма – s», «Разность – r».
  • Не пытайтесь зашифровать всё в аббревиатурах и сокращениях.
  • Не играйте с регистрами.
  • Используйте односложную латиницу только для простых циклов, счётчиков и, максимум, использования в качестве временного буфера для присваивания.
  • Любые переменные должны создаваться для строго одного использования с минимальной зоной действия.
  • На каждую операцию «Open» должна быть обратная «Close».

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

2. Планируйте переменные и операции до начала написания кода. Потратьте пару часов перед стартом проекта, чтобы нарисовать блок-схему, обозначить основные этапы, объекты, выделить функции и процедуры, выдать точные и понятные имена всем переменным. Это спасёт вас от бесконечных скачек по коду, глупых ошибок, и, в конечном счёте, ускорит создание. Плюс, у вас всегда будет наглядная инструкция для заказчика или начальника.

3. Оставляйте комментарии. Удивительный факт: людей, которые любят комментировать вслух каждый обрывок фразы – очень много, а вот программистов, подробно расписывающих выполняемые операции – максимум один из пяти. Да, это занимает достаточно много времени, зато отлично повышает профессиональный уровень кода. Плюс, позволяет безболезненно работать над ним впоследствии абсолютно любому разработчику.

4. Полюбите табуляцию. Долой сплошной неразборчивый текст. Каждый любитель знает, что создание правильной архитектуры табуляций предотвращает ошибки и заметно упрощает проверку. Благодаря изящно смещённому коду всегда видна очередность операций и рамки исполнения. Строго держитесь обозначенных отступов и, поверьте, завершающий символ, возвращённый в нулевую позицию, доставит вам чуть-чуть больше радости.

5. Не жалейте места. Никаких записей вида:

if (a==0){i++;}

Экономия места на сокращении пустых строк, до добра не доведёт. Да, может если ваш код составляет 20 строк, это приемлемо. Но что, если он разрастётся до нескольких тысяч? В этом случае вы рискуете просто потерять данный 15-символьный оператор. Прекращайте переживать за электронную бумагу, ради неё леса не вырубают, заводы углекислый газ не выбрасывают, она любые пробелы стерпит.

6. Помните об основах ООП. Возможно, пока в вашу работу не полез человек с руками не из того места, для вас нет необходимости создавать разные классы, типы, разбивать код по блокам, разделять зоны использования переменных, орагнизовывать наследевание и инкапсуляцию. Но рано или поздно этот день настанет. В лучшем случае, когда коллега решит притормозить вашу бурную радость, в худшем – когда будет разрабатываться методика испытаний для проверки работоспособности кода. А если рано или поздно работу придётся выполнить, зачем откладывать в долгий ящик?

7. Стремитесь к совершенству. Если у вас есть время, если есть возможность превратить хороший продукт в превосходный, не надо ждать специальных указаний. Просто берите и делайте. Всегда старайтесь перерабатывать решения в пользу минимизации текста, изящества и быстродействия. В конце концов, ну не для рутинных же повторений вы пришли в профессию.

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

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

А на какие мелочи в оформлении обращаете внимание вы?
 

P. S. Тем, кто хочет стать программистом, рекомендуем профессию «Веб-разработчик».

Новые комментарии