Хорошо написанный код

Итак, какой же код можно назвать хорошим?
Я решил собрать выбрать наиболее важные критерии «хорошего кода» и вот они:

1) Код не должен содержать ошибок (будь то граматических или же ошибок самого кода)

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

2) Код должен быть максимально задокументирован.

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

3) Максимальная кросплатформенность.

Большенство язков программирования при выходе новых версий поддерживают функции предыдущих. Не все конечно, но большинство. При написании кода надо стремиться использовать простые конструкции и те функции которые с большой вероятностью попадут в следующий релиз. Так к примеру не стоит использовать в php дерективу registr_globals так как ещё в 4-й версии было понятно, что от неё надо избавляться; или свойство opticaty, используемое в css не поддерживается в браузерах серии IE. Конечно, нельзя предугадать мысли разработчиков ядра языка, но заведомо кривые варианты надо исключать.

4) Отступы и форматирование.

Гораздо приятнее смотреть правильно отформатированный код и искать в нём нужные участки. Большинство программистов, которые пишут не одноразовый код, форматируют его. Но есть индивиды, которые упорно обходят это правило, не понимая, что потом найти что-то в коде или выдернуть кусок для другой работы потом не реально.

5) Правильное именование классов и методов.

Очень важный критерий хорошего кода. Названия функциям и методам необходимо придумывать такие, чтоб было понятно для чего эта функция предназначена. Так, например, из названия функции GetElementById понятно, что эта функция получает параметры элемента по его идентификационному номеру (скорее всего уникальному) и обязательный параметр это ID элемента. И не стесняйтесь больших букв в регистронезависимых системах, это влияет на читабельность названия. Так же можно в качестве разделителя применять знак «_» и не следует применять знак «.», так как точка может быть знаком конкатенации.

6) Отсутствие «быдлокода».

Часто за неимением времени даже опытные программисты пишут быдлокод. Все критерии быдлокода описать очень тяжело, примеров масса (их можно посмотреть на govnokod.ru). Изучите быдлокод и не повторяйте чужих глупостей. Даже одноразовый скрипт лучше писать без быдлокода.

7) Код должен работать быстро.

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

Я привёл только самые важные на мой взгляд критерии, вы всегда можете оставить в комментариях ваши для назидания будущим поколениям :)




Рекомендуем почитать

 

Добавить комментарий


Ваше имя:


Комментарий:


Введите: Картинка