Применение комментариев

Комментарий используется для увеличения наглядности исходного текста программы и может содержать любой печатный символ кода ASCII, в том числе включать пробелы и табуляцию. При компиляции исходного текста программы в исполняемый или объектный код комментарии игнорируются программами-трансляторами. Рассмотрим конкретные примеры использования комментариев.

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

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

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

Еще более крупные блоки алгоритма выделяют специальными символами, которые сразу бросаются в глаза (обычно это звездочки или символы знака минус '-'). Пример использования комментариев на языке программирования ассемблер приведен ниже:

...

;ПЕРЕДАТЬ ДВА ЧИСЛА ПО ПОСЛЕДОВАТЕЛЬНОМУ ПОРТУ КОММЕНТАРИЙ АЛГОРИТМА ВТОРОГО УРОВНЯ

MOV G_Per, #56;Передать число 56 через КОММЕНТАРИЙ, ПОЯСНЯЮЩИЙ ДЕЙСТВИЯ

CALL PeredatByte;последовательный порт НЕСКОЛЬКИХ ОПЕРАТОРОВ

MOV G_Per, #37;Передать число 37 через

CALL PeredatByte;последовательный порт

;------------------------------------------ КОНЕЦ БЛОКА АЛГОРИТМА ВТОРОГО УРОВНЯ

...

;********************************************

;Подпрограмма передачи байта ТАК ВЫДЕЛЯЮТСЯ ОСОБО

;через последовательный порт ВАЖНЫЕ БЛОКИ АЛГОРИТМА

;********************************************

PeredatByte:;КОММЕНТАРИЙ, ПОЯСНЯЮЩИЙ ДЕЙСТВИЕ

JB TI,$;Если предыдущий байт передан КОМАНДЫ В ДАННОМ КОНКРЕТНОМ СЛУЧАЕ

MOV SBUF,G_Per;то передать очередной байт

RET

В приведенном примере показан отрывок программы на языке ASM-51, где строка комментарий отделяется от основного содержания «;», но точно так же можно использовать комментарии и на языке высокого уровня с другими разделителями, например, «/» или «/*,*/». При этом нужно помнить, что те действия, которые абсолютно ясны в момент написания программы через месяц вызовут затруднения даже у программиста, написавшего эту программу, не говоря уже о человеке, который видит эту программу впервые.

Программа, написанная на языке программирования ассемблер, читается прежде всего по комментариям и только потом, если она по каким либо причинам не работает, проверяется на соответствие комментария конкретным операторам языка программирования.

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