Группы пользователей Autodesk


Комментарии в тексте программы


Средства отладки Visual LISP

 

Средства отладки Visual LISP  

Комментарии в тексте программы

Все выражения в программе на языке AutoLISP, начинающиеся с точки с запятой, считаются комментариями. В предыдущих двух примерах кода содержится множество таких комментариев. Комментарии в AutoLISP предназначены для самого разработчика, и не учитываются программой. Включение в текст программы комментариев является одним из признаков хорошего стиля программирования, к которому следует стремиться. Для чего же нужны комментарии?

  • Для того, чтобы код был понятен самому разработчику при редактировании программы и добавлении в нее новых возможностей месяцы спустя. Человеческой памяти свойственно быстро забывать подробности реализации алгоритмов, и даже самая очевидная последовательность функций через некоторое время может восприниматься как непонятный набор скобок.
  • Для того, чтобы код был понятен другим людям, несущим ответственность за дальнейшее сопровождение программы. Читать код, написанный другим человеком, утомительно и сложно — особенно если в нем практически не содержится комментариев.

В VLISP включены средства, помогающие комментировать код. Следует обратить внимание на то, что некоторые комментарии в примерах начинаются с трех точек с запятой (;;;), некоторые с двух (;;), а некоторые только с одной (;). Об обработке различных комментариев с помощью VLISP см. в разделе “Applying Visual LISP Comment Styles” руководства AutoLISP Developer’s Guide.

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

 




Начало  Назад  Вперед