Auto CAD

Значащие имена переменных


Используйте значащие имена переменных. Я стараюсь давать переменным зашифрованные имена, такие как pi, р2 или рз для точек. Пол и Скотт же используют такие имена, как lineStartPoint и lineEndPoint.

Пользуйтесь для переменных "правилом верблюда". Непонятно? У верблюдов есть горбы. Если имена ваших переменных составлены более чем из одного слова, делайте первую букву первого слова строчной, а первые буквы остальных слов — заглавными, например, textlnsertPoint. При этом не должно быть пробелов. Разделяйте функции и переменные, для этого при создании функции применяйте заглавные буквы для всех слов, составляющих имя. Например, программа DTR могла бы выглядеть следующим образом: DegreesToRadians. Зачем? Чтобы упростить отладку кода.

Добавляйте комментарии в ваш код. Иногда я действительно добросовестно отношусь к этому, иногда — нет. Для двух глав, посвященных AutoLISP в этой книге, я поместил комментарии к большей части кода, чтобы вы понимали, что

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

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

Помечайте каждую закрывающую скобку, завершающую секцию. Вам будет проще отлаживать программу, если вы сможете быстро находить завершение различных секций, например: );while, или ); if, или ); defun. Не забывайте, что вся остальная часть строки после точки с запятой является комментарием, поэтому не пытайтесь поместить его где-либо в середине строки. Она должна находиться либо в конце строки, либо в отдельной строке. Если вы пользуетесь редактором Visual LISP, вы не ошибетесь, потому что все, что находится после точки с запятой, оформляется цветом как комментарий.

Комментарии закрыты