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

Контекстные подсказки

Чтобы получить подсказку в среде Flash MX, не обязательно запускать Help или смотреть References. Некоторые подсказки могут появиться непосредственно при наборе кода. Например, если набрать " my_mc.", то рядом с курсором появится список полей и методов класса MovieClip, из него можно выбрать элемент, который вставится в код. Такие же подсказки можно сделать и для собственных классов (рис. 12.5).

Эти подсказки описываются также в xml-файле, за них отвечает тег <codehints>. Тег не имеет атрибутов, но может содержать теги <codehint> и <typeinfo>. В тегах <codehint> описаны паттерны кода вроде " on " или " onClipEvent ". При написании классов новых таких паттернов не возникает, так что этот тег нам не понадобится. А вот в тегах <typeinfo> как раз и содержится информация о контекстных подсказках вроде тех, что показаны на рис 12.5.

Рис. 12.5. Контекстные подсказки

Тег <typeinfo> имеет атрибуты pattern и object.

pattern - часть кода, по которой выдается подсказка. Как правило, для этого используются суффиксы, начинающиеся с символа " _ ".

object - объект, список полей которого выдается в подсказке.

Например:

<typeinfo pattern="*_lift" object="Lift"/>

Для того чтобы поле попало в список, выпадающий по данному паттерну кода, в теге <string>, описывающем данный метод, должен быть атрибут object, значение которого совпадает со значением атрибута object соответствующего тега typeinfo.

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

На паттерны " _level* ", " _parent " и " _root " также выдаются подсказки MovieClip 'а.

Кроме списка методов и полей, для каждого метода можно получить подсказку по синтаксису его вызова (рис 12.6).

Рис. 12.6. Контекстные подсказки по вызову метода

За это отвечает атрибут text тега <string>.