Главная » Delphi » Совет 2 — о комментариях и именах переменных

0

Текст программы должен быть как можно подробнее комментирован. Это тот самый случай, когда требования ГОСТа полностью отвечают реальному положению вещей. Той же цели повышения читаемости программ служит требование. чтобы наименования идентификаторов переменных были как можно более осмысленными: программа не рухнет, если вы назовете несколько переменных типа file именами 11, ?2 и т. д. Но вам не придется каждый раз искать в тексте место с их инициализацией, чтобы вспомнить, что fi— „но файл установок, а ?2 — журнал (log-файл), если вы с самого начала присвоите им имена, например, file set и file log. Хорошим методом изобретения идентификаторов является присвоение "говорящих" имен по звучанию (iks, igrek) или записанных транелнтом по-русски (stroka). При присвоении имен использование фантазии по максимуму не возбраняется, но туг главное — не переборщить. Так, для именования простых численных переменных удобно использовать имена, аналогичные обозначениям в обычной алгебре: х, у, i, п и т. д. Вряд ли целесообразно затемнять смысл текста программы чем-то принципиально более навороченным.

Заметки на полях

В Windows используется так называемая "венгерская нотация", названная в честь программиста Чарльза Саймони (Charles Simonyi), венгра по происхождению. Он начинал свою карьеру еще на советских "Уралах" в начале 60-х, а в 70-е годы в упоминавшемся Xerox PARC звнимался разработкой WYSIWYG- редактора Bravo. Позднее он стал главным архитектором MS Office (отсюда понятно, почему сам по себе MS Word, в отрыве от системы и поздних наслоений — вполне приличная вещь). Придуманная им нотация (т. е. правила записи имен переменных) заключается в том, что каждый идентификатор должен содержать префикс, информирующий о типе переменной. Само же наименование любой переменной должно отражать ее назначение и смысл. Тогда названия переменных — при надлежащем опыте — легко расшифровать. Так. имя "wm_KeyDown" говорит, что это сообщение Windows (Windows message), означающее, что нажата некая клавиша, а имя "faAnyFile" — что это набор атрибутов (file attributes), идентифицирующий любой (any) файл. Никто не запрещает вам придумывать и использовать свои собственные префиксы. Так, автор этих строк за некоторыми понятными исключениями старается начинать идентификаторы файловых переменных с букаы "Р, строковых — с букв "st", массивов — с буквы "a" (array) и т. л. Некоторые Unix-программисты резонно замечают, что венгерская нотация ведет к излишним сложностям (например, еспи в процессе перехода на другую платформу тип переменной изменится, то придется переписывать весь код), что в значительной степени справедливо.

Источник: Ревнч Ю. В.  Нестандартные приемы программирования на Delphi. — СПб.: БХВ-Петербург, 2005. — 560 е.: ил.

По теме:

  • Комментарии