15 и более самых лучших методов написания суперчитаемого кода
От автора: Читаемость кода – универсальный предмет в мире компьютерного программирования. Это – самое первое, о чем мы узнаем в качестве разработчиков. Читаемый и легко поддерживаемый код в законченном продукте – это нечто, чем можно гордиться. Им можно поделиться с друзьями, внести в другие проекты, использовать снова и снова из приложений, которые были написаны месяцы и даже годы назад.
В этой статье детально описаны пятнадцать самых важных и лучших методов, применяемых для написания читаемого кода.
1. Комментируйте & Документируйте
IDE (среды интегрированной разработки) за последние несколько лет прошли долгий путь. Это сделало комментирование кода более полезным, чем когда-либо. Следование определенным стандартам в комментариях позволяет IDE и другим инструментам в дальнейшем использовать их в разных случаях.
Практический курс по верстке адаптивного сайта с нуля!
Изучите курс и узнайте, как верстать современные сайты на HTML5 и CSS3
Комментарии, добавленные в определение функции, могут просматриваться даже из других файлов каждый раз, когда функция используется.
Вот другой пример, когда я вызываю функцию из сторонней библиотеки:
Конкретно в этих примерах тип используемого комментария (или документации) основан на PHPDoc, а IDE — Aptana.
2. Согласованные отступы
Я полагаю, вы уже знаете, что в коде нужно делать отступы. Однако, эта хорошая идея имеет смысл только если ваш стиль отступа последователен.
Есть несколько способов введения отступов в код .
Я обычно пользовался способом № 2, но недавно переключился на способ № 1. Но это дело вкуса. Не существует «самого лучшего» способа, которому все должны следовать. Собственно, самый лучший способ – быть последовательным. Если вы – участник команды или вносите в проект код, нужно следовать тому способу, который используется в проекте.
Способы введения отступов не всегда можно полностью отличить один от другого. Иногда в них смешиваются различные правила. Например, в стандартах кодирования PEAR открывающая скобка «