Добавление комментариев ActionScript

Во время этого урока ActionScript мы рассмотрим один вопрос:

Добавление комментариев ActionScript

Комментарии ActionScript – это Ваши пояснения или замечания, сделанные по поводу той или иной инструкции, которые Вы записали в коде ActionScript. Во время воспроизведения flash-ролика Flash Player игнорирует комментарии, т.е. они не воспризводятся. Одним словом, цель комментариев задокументировать происходящее в Вашем коде для того, чтобы облегчить работу с кодом по прошествии времени. Через полгода мы можем многое просто забыть и комментарии помогут нам вспомнить!

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

Вы можете добавить комментарий ActionScript одной строкой, поставив перед ним две наклонных черты " // " (forward slash). Любой текст после них будет проигнорирован во время воспроизведения фильма:

var clientOrders:int = 24;   // количество заказов клиента

Комментарии ActionScript, состоящие из нескольких строк нужно записывать следующим образом: в начале поставить наклонную черту (forward slash) и звездочку (asterisk) " /* " затем написать комментарий, завершая его звездочкой (asterisk) и наклонной чертой (forward slash) " */ ". Весь текст, который будет находится между – Flash Player не примет во внимание.

/* Это многострочный комментарий,
   который может быть использован для
   описания сложных задач, выполняемых
   определенным куском скрипта */