Средства документирования во Flash MX

Подсвечивание кода

Вероятность допустить синтаксическую ошибку заметно снижается, если "правильно" набранные, заведомо узнаваемые интерпретатором слова выделяются цветом. А для работы во Flash MX, который, ни слова не сказав, честно попытается вызвать несуществующий метод или обратиться к несуществующей переменной (если вы ему это нечаянно скомандовали), это особенно важно.

Разными цветами в редакторе выделяются следующие объекты: строки, комментарии, ключевые слова и идентификаторы. На то, что определяется как строки и комментарии, мы повлиять не можем, ключевых слов в язык тоже не добавим, а вот раскрасить как идентификаторы доступные пользователю поля и методы наших классов было бы полезно.

За это отвечает тег <colorsyntax>. Он не имеет атрибутов, содержит теги <identifier> (и <keyword>, но они нам не понадобятся). Каждый тег <identifier> имеет атрибут text, значение которого и задает то слово, которое надо раскрасить. Например:

<colorsyntax>
   <identifier text="Lift"/>
   <identifier text=".goto"/>
   <identifier text=".minFloor"/>
   <identifier text=".maxFloor"/>
</colorsyntax>

Описания для Normal mode

Кроме обычного режима ( Expert mode ), редактор FlashMX допускает еще один режим, Normal mode (рис. 12.7), в котором не позволяется вставить в код ничего "лишнего". Пользователь, выбравший для редактирования кода Normal mode, даже не имеет возможности набирать текст в основном окне - только в специально отведенных для этого полях (надо заметить, что до пятой версии Flash только такая возможность и существовала).

Рис. 12.7. Normal mode

Для того чтобы и в Normal mode была возможность пользоваться вашими классами, их необходимо описать в уже обсуждавшихся ранее тегах <string>. Сейчас нам важны атрибуты text, tiptext и type. Атрибуты text и tiptext используются как в Expert-mode, так и в Normal mode. В Normal mode значение атрибута tiptext выводится в верхней строке окна Actions (см. рис. 12.7). Атрибут text, который в Expert mode отвечает за удобную, но необязательную подсказку, в Normal становится жизненной необходимостью. Именно то, что указано в атрибуте text, в Normal mode и вставится в текст программы, п ользователю же будет разрешено ввести только то, что находится между значками " % ". Если метод допускает больше одного варианта вызова, можно пользоваться атрибутами text2, text3 и т. д.

Атрибут type используется только для редактирования в Normal mode. Если ему присвоено значение " procedure ", то пользователю будет предоставлен шаблон для вызова метода - то есть, его попросят указать объект, у которого этот метод вызывается, и перечислить аргументы. Если речь идет о полях, которые не являются методами, атрибут type можно не указывать.

В примере 12.4 приведено описание метода goto класса Lift, а на рис.12.8 показано добавление этого метода в код при редактировании в Normal mode.

<string name="goto" tiptext="Метод, отправляет лифт на заданный этаж"
text=".goto(% floor %);" text2=".goto();"type="procedure"
                        object="Lift" version="6" />

Рис. 12.8. Редактирование в Normal mode