| |
Учебник по Delphi
Комментарии.
Когда я только постигал азы программирования, то узнал, что желательно писать
в тексте программы комментарии. Естественно, я отнесся к этому довольно скептически,
не понимая, зачем нужны комментарии. Над программой я работаю один,
следовательно, знаю и помню, что. в ней написал. Однако прошло некоторое время,
и наступил момент, когда пришлось создавать новую версию какой-то программы.
Тогда я и пожалел, что не пояснил комментариями фрагменты кода. Я многое забыл,
и, чтобы внести изменения в программу, сначала пришлось долго в ней разбираться.
С тех пор я снабжаю свои программы комментариями. И делаю это даже тогда,
когда уверен, что не буду переписывать программу. Когда уверен, что не будешь
вносить изменения в программу, — непременно придется это сделать!
Но я вам не буду советовать писать комментарии в тексте программы. Только когда
вы сами однажды обнаружите, что ничего не понимаете в программе, которую
сами же написали несколько месяцев назад, тогда комментарии в программе вам
будут просто необходимы! И вы будете писать их с удовольствием!
Как уже говорилось в разд. 3.3, для добавления комментариев в Delphi можно использовать
две косые черты //, а также фигурные скобки { ) . Короткий комментарий
(строка или часть строки) проще оформить с помощью косых черточек, а длинный
(несколько строк) — поместить в фигурные скобки.
Комментариев в тексте программы не должно быть слишком мало или много, а ровно
столько, сколько необходимо для понимания того, что выполняется в комментируемом
фрагменте кода, для чего нужна та или иная переменная. Писать длинные
пояснения не нужно.
Рассмотрим пример программы с комментариями, необходимыми для ее понимания.
Листинг 9.12
procedure TForm1.MakeMoney(m: Integer);
// создание денег с помощью чит-кода1
// т- количество добавляемых денег
begin
if lnputCode=False then Exit; // запрос чит-кода
Randomize; ;
m := Random(IOOOO);
A.money := A. money + m;
end;
Как видите, комментариев немного, но все фрагменты, по которым могут возникнуть
вопросы, снабжены комментариями. Теперь приведу пример неправильного
употребления комментариев в той же процедуре.
Листинг 9.13
procedure TForm1.MakeMoney(m: Integer);
// процедура для создания денег чит-кодом
// т- количество добавляемых денег
begin
if InputCode-False then Exit; {если введенный пользователем
код неправильный, то выполняется выход из процедуры}
Randomize; // инициализация генератора случайных чисел
m := Random(IOOOO); // генерирование денег (случайное число)
A.money := A.money + m; // добавление денег
end;
Данный листинг перегружен комментариями. Своей функции — облегчать чтение
программы — комментарии не выполняют, потому что такое нагромождение только
вредит. Программист и так знает, что Randomize инициализирует генератор
случайных чисел. Не нужно указывать это еще и в комментарии. Комментировать
же предназначение переменных очень желательно.
|
|
|
