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

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

Совет #4

Придерживайся стандарта в именовании идентификаторов. Всего существует 3 стандартных схемы:

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

2. В качестве идентификатора записывается целая фраза, а вместо пробелов используются символы подчеркивания, например: toilet_is_clogged (на мой взгляд, самая понятная, но и самая громоздкая схема).

3. Идентификаторы записываются в так называемой «венгерской» нотации. Тут, думаю, нужно немного пояснить. Придуманная одним из руководителей Micro$oft, Чарльзом Симони (венгром по национальности), благодаря всеми уважаемой и любимой фирме :), «венгерская» нотация стала знаменита на весь мир. Именно ее ты можешь лицезреть в Windows API. Главное преимущество «венгерской» нотации состоит в том, что она отражает не только смысл переменной или функции, но и тип, что бывает очень удобно; например, при необходимости не нужно искать то место, где объявлялась переменная. По сути «венгерская» нотация эта система префиксов, которые добавляются к имени переменной или функции. Например, переменная целого типа Children в венгерской нотации будет записана как iChildren. Вот еще несколько префиксов: s - string, c - char, w - word, dw - dword, p - указатель и т.п. В одном идентификаторе может быть одновременно несколько префиксов, например, psMotherFucker - указатель на строковую переменную. Короче, даже если ты не собираешься использовать эту нотацию в своих прогах, я все же настоятельно советую изучить ее, хотя бы для того, чтобы легко читать чужой код с ее применением, что, имхо, непросто сделать, т.к. «венгерская» нотация напоминает бормотание индюка :).

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

Совет #5

Не соглашайся с названиями элементов управления (компонентов), которые визуальные среды дают по умолчанию - типа Edit1, Edit2, Edit3 и т.д. Сразу же меняй их на что-нибудь более осмысленное, например, edGeneral, edSquare, edVolume. Вообще, именование элементов управления идет отдельным пунктом от трех стандартных схем именования идентификаторов. Элементы управления принято именовать с префиксом (обычно двухбуквенным или трехбуквенным), напоминающим о типе компонента или его свойстве, как это делается в «венгерской» нотации. Советую именовать таким способом компоненты, даже если ты не используешь «венгерскую» нотацию. Должен заметить, что, к сожалению, не существует единого стандарта по именованию элементов управления (по крайней мере, он мне неизвестен); каждый делает это как ему в голову взбредет, поэтому советую выбрать префиксы самостоятельно, а в начале проги отметить это в комментариях.