20 советов по созданию настоящего Х-кода (часть II)

Xakep, номер #038, стр. 038-067-1

Иван Скляров (sklyarovivan@mail.ru)

Ты, наверное, знаешь такую народную мудрость, что дураки учатся на своих ошибках, а умные на ошибках дураков. Так вот, после первой двадцатки советов по созданию настоящего Х-кода у меня и в мыслях не было писать их продолжение, т.к. с детства не люблю сериалы :). Но под напором писем от множества хитрых умников, которые не хотят учиться на своих ошибках, мне не пришлось поспать несколько ночей, чтобы собрать дополнительные 20 советов, до которых многие «дураки» с потом и кровью доходили не один десяток лет. И теперь умники-халявщики могут получить многолетний опыт «дураков» буквально за 15 минут (обидно-то как!). В создании данных советов принимали участие такие знаменитые «болваны», как Керниган и Ритчи, Бьерн Страуструп, Дональд Кнут, Полтер Гейтс... тьфу, Билл Гейтс и другие менее известные «идиоты» :).

О чем это вы?

Если амнезия не твой конек, то ты должен помнить, что первая двадцатка советов была посвящена оптимизации кода. Вторая двадцатка советов ориентирована в основном на создание больших и сложных программ. Тебе, наверное, знакома такая ситуация, когда легче написать программу самому, чем разбираться в чужом многометровом коде, или когда ты вскрываешь код своей проги, написанный год назад, и понимаешь, что разобраться в нем практически без шансов. Так вот, это объясняется только тем, что ни ты, ни тот чувак, чей код тебя интересует, не умеете создавать понятные и самодокументируемые программы, что так важно в современном программировании. Данные советы помогут избежать подобных траблов. Придерживаясь этих советов, ты сможешь спокойно «летать» по своему коду размером в несколько десятков тысяч строк даже по прошествии многих лет. Уверен, их оценят и те, кто работает с тобой в команде. И все-таки хочу заметить, что это всего лишь советы... ни правила, ни приказы, ни табу, а ВСЕГО ЛИШЬ СОВЕТЫ, т.е. следовать им или нет, твое сугубо личное дело, но миллионы программистов по всему миру говорят однозначно: «Следовать!».

Совет #1

Давай осмысленные имена идентификаторам (переменным, функциям, процедурам, методам и т.д.). Например, как определить, что выражение y = x + z вычисляет количество чилдренов в классе? Но, если использовать именованные переменные, например: Children = ChildrenBoys + ChildrenGirls, то всем все сразу становится ясным без лишних комментариев. Таким образом, избегай в своем коде однобуквенные переменные типа x, y, z и т.п., если, конечно, не строишь график функции. Лучше потратить несколько минут на придумывание подходящего имени переменной, чем потом часами чертыхаться при отладке.

Совет #2

В именах идентификаторов используй исключительно английские слова, а не транслит, типа EtoPeremennaya, чтобы твой код могли легко читать и потные нигеры на плантациях :). К тому же английские слова намного короче русских. Не советую также использовать аббревиатуры и сокращения, чтобы потом самому не пришлось провести утомительные часы, вспоминая: «Как же ЭТО расшифровывается?».

Совет #3

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