Правила хорошего тона в программировании

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

1. Всегда делайте отступы

Самое сложное, в неправильно структурированной программе — это найти вообще что бы то ни было. Где начался цикл, где он закончился. Где начало этого блока. Эта переменная участвует в условии, или нет.
Попробуйте сами понять, как это выглядит, например в коде php:

function get_theme() {
global $user, $conf;
if (!defined("ADMIN_FILE") && is_user()) {
$utheme = $user[5];
if (file_exists("templates/$utheme") && $utheme != "") {
$theme = $utheme;
} else {
$theme = $conf['theme'];
}
} elseif (!defined("ADMIN_FILE")) {
$theme = $conf['theme'];
} elseif (defined("ADMIN_FILE")) {
$theme = "admin";
}
return $theme;
}

Пример взят из всем известного движка PHP-Nuke.

Так же, при создании отступов, считается наиболее правильным ставить пробелы, а не символы табуляции.
Честно говоря, я считаю, что это на любителя. Я, лично, люблю табуляцию. Так как это быстрее и легче. Но если для вас нет никакой разницы, то лучше использовать пробелы. За это многие скажут спасибо.

2. Используйте понятные названия

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

$je34a — неверно.
$user_age — верно.

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

3. Не начинайте программировать сразу

Я понимаю, всегда возникает желание, при возникновении идеи, сразу с головой бросаться в бой с кодом, но, если ваш проект имеет хоть какую нибудь мизерную возможность стать больше и шире, то спроектируйте архитектуру приложения на бумажке, либо с помощью любого другого, более удобного вам инструмента.
Чем более продумана архитектура приложения, тем легче ее в будущем расширять и дописывать. Тем меньше сил уйдет на то, чтобы сделать всю работу сначала, но «по правильному».

4. Комментируйте

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

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