Комментарии MEL

Комментарии    (comment)  —   это   способ   документирования  кода,   предоставляемый разработчику.  Комментарии  весьма полезны,  когда  приходится  возвращаться к  коду,  на­ писанному ранее,  когда  создается  сложный,  малопонятный  код,  когда  код  предназначен для чтения другими  разработчиками.

Комментарии  начинаются двумя символами  косой  черты  (//) .  При  выполнении  сце­ нария интерпретатор  игнорирует все, что  следует  за  двумя  символами  косой  черты  в этой строке.  Рассмотрим несколько  примеров  комментариев:

// Авто р сценария :    Джо н До

polyCube -n myCube ;      // создать ку б по имен и myCub e

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

Для комментариев  из  нескольких строк,  применяемых обычно  в  начале  сценария,  мож­ но также  использовать символы / => , указывающие начало  многострочного  комментария. Все, что  находится после  этих символов,  будет  игнорироваться  анализатором MEL до тех пор, пока он не встретит символы => /, означающие конец многострочного  комментария.

В  начало  сценария всегда следует  включать комментарий о  том,  для  чего  предназна­ чен  данный  сценарий, каковы  его  аргументы  (входящие данные),  если  они  нужны  (это описано далее, в разделе посвященном процедурам),  кто его писал,  кто  модифицировал и когда.  Кроме того, неплохая идея поместить в код сценария комментарий "use at you r own risk" (используйте на свой страх  и  риск),  указывающий, что  в  случае  непредви­ денных  проблем  автор сценария не несет  никакой ответственности  за любые  возможные последствия (увы, нынешнее  общество  так любит судиться).

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

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

//   Z   равн о   х   плюс   у

$Z   =   $х  +   $у ;

Источник: Кундерт-Гиббс, Джон,  Ларкинс, Майк,  Деракшани, Дариус, Кунзендорф, Эрик,  и др., Освоение Maya  8.5.:  Пер.  с англ.  – М.:  ООО  «И.Д.  Вильямс», 2007.  – 928  с.:  ил.

По теме:

Вы можете оставить комментарий, или ссылку на Ваш сайт.

Оставить комментарий