5.3.9 element: Идентификатор документации

На верх  Назад  Вперёд

Элемент (element) содержит документацию для идентификатора в модуле. Это должно происходить внутри тега module. Он может содержать 4 тега:

short

Для однострочного описания идентификатора. Используется в качестве заголовка или используется в обзорах констант, типов, переменных или классов.

descr

Содержит фактическое описание идентификатора.

errors

Для функций процедуры это может использоваться для описания условий ошибки. Он будет помещен в отдельный раздел ниже раздела описания.

seealso

Используется для обозначения других узлов. будет набираться в отдельном разделе.

Тег element должен иметь атрибут name по крайней мере, он используется для связывания узла элемента с фактическим идентификатором в модуле Pascal. В будущем могут быть добавлены другие атрибуты.

Пример:

<element name="MyEnym">
<descr>Myenum - просто элемент перечисления</descr>
</element>

Поддерживаются следующие атрибуты:

name

этот атрибут требуется и должен совпадать с именем идентификатора.

opaque (непрозрачный)

этот атрибут используется для непрозрачных типов: если установлено значение 1, объявление будет заменена термином «непрозрачный».

link (ссылка)

это должно содержать имя элемента. Ссылка на текущий элемент будет отнесена к этому идентификатору. Это можно использовать в переопределенных методах/свойствах, чтобы вместо этого ссылаться на родительскую документацию.

Не работает связь link="ИмяЭлемента.Result"!!!

alwaysvisible (видимый всегда)

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

skip (пропускать)

если установлено значение 1, элемент не будет отображаться в каких-либо обзорах. Страница документации может быть сгенерирована в HTML, но она не будет связана с каким-либо обзором.

Смотри также: descr (165), short (212), errors (175), seealso (210)