5.3.1 Обзор

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

Теги можно условно разделить на две группы:

1.Тег структуры документации. Они необходимы для работы fpdoc. Они определяют, какие элементы документированы. См. Таблицу (5.1)

2.Текстовая структура и теги форматирования. Эти теги указывают блоки текста, такие как абзацы, таблицы, списки и примечания, но также определяют форматирование: применять форматирование (подпитку) к тексту или предоставлять ссылки на другие части текста. Они чаще всего встречаются в тегах текстурной структуры. См. Таблицу ( 5.2 )


Таблица 5.1: Тег структуры документации

Тэг

Описание

descr

Описание элемента

element

Документация по идентификаторам

errors

Раздел ошибок

fpdoc-description

Глобальный тег

module

Тег модуля

package

Глобальная закладка пакета

seealso

Секция перекрестных ссылок

short

Краткое описание

topic

Тема страницы

Таблица 5.2. Теги форматирования текста

Тэг

Описание

b

Формат полужирный

caption

Укажите заголовок таблицы

code

Код выделения синтаксиса

dd

данные определения

dl

список определений

dt

Термин определения

i

форматирование курсивом

img

включить изображение

li

элемент списка

link

Перекрестная ссылка

ol

нумерованный список

p

параграф

pre

Форматированный текст

remark

примечание

table

Таблица

td

Ячейка таблицы

th

Заголовок таблицы

tr

Строка таблицы

u

подчеркнутый формат

ul

маркированный список

var

формат как переменная

Узлы форматирования текста напоминают основные теги форматирования HTML со следующими исключениями:

Каждый открытый тег должен иметь соответствующий закрывающий тег.

Теги чувствительны к регистру.

Таблицы и абзацы находятся на одном уровне, т.е. таблица не может встречаться внутри абзаца. То же самое верно для всех «структурных» тегов, таких как списки.

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

<descr>
Текст начала
<ol>
<li>Элемент списка</li>
</ol>
Текст окончания
</descr>

Вместо этого правильный XML должен быть

<descr>
<p>Текст начала</p>
<ol>
<li>Элемент списка</li>
</ol>
<p>Текст окончания</p>
</descr>

Если нужно вставить символ (например больше(>) или меньше (<) или пробел), можно использовать мнемоники в HTML. (при этом нужно учесть, что символ "<" это (&lt;),  символ ">" (&gt;), остальные символы - это (&#НомерИзТаблицыСимволов;))