7 шагов к красивому коду

Вы замечали, что разработчики и дизайнеры одержимы списками? Причины не так важны, статистика говорит сама за себя. Возьмем за пример DZone: 2 из 3 самых популярных статей это списки: «15 CSS хитростей, которые стыдно не знать» и «10 Грязных Маленьких хитростей Веб-разработки». Кстати, мне понравились обе статьи, поэтому я, кажется, проникся идеей создания списков. В этой статье я решил удовлетворить свое желание, поэтому ловите: 7 шагов к написанию красивого кода. В первую очередь, я говорю о чисто эстетической составляющей. Работающий код начинает быть красивым кодом, когда легко читается. На самом деле этому посвящено немало слов в блоге Джеф Этвуд, и любопытные могут посмотреть его. А пока, внимание, мой список.

1. Возвращайтесь от оператора if так быстро, как это возможно.

Например, рассмотрим следующую кошмарную функцию в JavaScript: Вместо этого, мы можем сделать следующее: Иногда не стоит нагромождать лишнего. Просто посмотрите на код и подумайте - приятно ли вам его читать? И можно ли его упростить?

2. Не используйте оператор if для проверки логической переменной.

Рассмотрим на примере: Просто удалите оператор if:

3. Используйте пробелы!

Пока Государственная Дума не запретила клавишу Enter - пользуйтесь ей! Вот еще один пример реального, живого кода. Все, что я сделал - это изменил язык программирования и некоторые имена функций. А теперь посмотрим, как это могло бы быть:

4. Не пишите бессмысленные комментарии.

Реально, это время можно потратить на пункт №3 или на поедание пончика. Пример:

5.Не оставляйте код исходного файла в комментариях, удалите его.

Если вы используете контроль версии – (Если нет, то почему?!) - То вы всегда можете вернуть исходный код легко, вернувшись к предыдущей версии. Нет ничего более странного, чем сохранение исходного кода в виде блока комментария. Что-то вроде того, что показано ниже.

6. Не делайте строки слишком длинными.

Нет ничего хуже, чем смотреть на строку кода, уходящую в бесконечность – особенно строку кода в интернете. Если вас при этом охватывает смесь ярости, отчаяния и безысходности - знайте, вы не одиноки. Я не заставляю вас придерживаться старой нормы в 70 символов, но, реально, разумное ограничение, порядка 120 символов, делает вещи немного легче. Очевидно, что если вы печатаете пример кода в интернете, и у Вас есть для этого фиксированная ширина блока - есть смысл разместить его в рамках блока, не усложняя читающему жизнь.

7. Не делайте слишком много строк в функции / методе.

Верите или нет, несколько лет назад, теперь уже старый мой коллега по работе воскликнул, что Visual C + + была "дерьмо", поскольку она не позволит вам иметь метод с более чем 10 000 линий. Я не шучу - ну хорошо, я не могу вспомнить точное количество линий, но это было огромно. И я вижу это часто- функции / методы из 50 строк и более. Для меня все, что выше 30-35 строк довольно трудно воспринимать, требуется прокрутка. Моя рекомендация - если в методе /функции болше, чем 10-15 строк - рассмотрите возможность его разделения. Это ни в коем случае не исчерпывающий список, и я мог бы составить и более длинный – если бы в начале статьи не заявил, что пунктов будет 7. Тем не менее, никто не запрещает написать Следующие 7 шагов к написанию красивого кода. Укажите ваши собственные неприятности и, возможно, следующий пост окажется не за горами.