10.4. Комментарии

Программа на ассемблере может содержать любые сообщения,  информирующие программиста о содержании текста программы. Такое сообщение называется комментарием. Комментарии могут находиться на любых строках программы. На каждой строке, где есть комментарий, ему предшествует точка с запятой (;). Подобно псевдооператорам комментарии не транслируются ни в какие машинные команды. Но в отличие от псевдооператоров они не интересуют и сам транслятор, существуя лишь для человека, который читает программу.

Добавим комментарии в записанную ранее программу на ассемблере:

              [org   100h]

;

;             Вывод звездочки на экран

;            -----------------------------------

;

mov   ah,2h          ; Функция  вывода  символа

mov   dl,2ah         ; Символ *  в  DL

int     21h             ;  Вывод  символа

int     20h             ;  Возврат  в  DOS

Теперь можно легко понять смысл программы. Обратите внимание на комментирование процедуры. Каждая процедура должна обязательно иметь вводные комментарии, которые содержат:

1) словесное описание функций процедуры;

2) перечень и способ передачи каждого входного и выходного параметра процедуры;

3) перечень процедур, вызываемых в данной процедуре;

4) перечень переменных (областей памяти), которые используются процедурой, с указанием для каждой переменной способа ее использования. Допустимые способы использования: чтение; запись; чтение-запись.

Для приведенной выше простой процедуры вводный комментарий содержит лишь описание функций процедуры.

Что касается  текущих комментариев, поясняющих назначение отдельных операторов программы и их групп, то к ним нет жестких требований. Желательно, чтобы были прокомментированы основные управляющие структуры программы (цепочки, ветвления и циклы). Кроме того, должны быть прокомментированы вызовы подпрограмм, т.е. операторы call и int. Каждый такой оператор инициирует десятки или сотни машинных команд и поэтому заслуживает пояснения.

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