5.3.18 notes: Заметки (анотации)

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

Тег notes указывает, что конкретный раздел документации содержит аннотации. Он состоит из одного или нескольких тегов note, не допускается использование других тегов. Они служат в качестве аннотаций к документации, как правило, в интересах писателя документации.

Таким образом, примечания по умолчанию не включены в окончательную документацию, но они могут быть добавлены к ним с помощью опции командной строки -emit-notes.

Заметки (notes) могут отображаться ниже тегов module, topic и element.

Для объяснения того, что может отображаться внутри самого тега заметки, см. note.

Пример:

<module name="classes">
<descr>
Модуль классов содержит базовые определения классов для FCL.
</descr>
<notes>
<note>MVC. Это устройство нуждается в дополнительном документировании</note>
<note>FK Новый класс MyVeryImportantClass требует документирования</note>
<notes>
</module>

Смотри также: note (??), module (191), topic (220) и element (173).