# 10.3. Специальные таги

Внимание: последующий текст этой главы взят из документации KDoc , поставляемой вместе с KDoc и написанной Sirtaj S. Kang taj@.kde.org), автором KDoc ; Copyright (c) 1997

Документация состоит из:

- Обычного текста. Параграфы должны быть разделены минимум одной пустой строкой.

- Текста в форме

         1 &<;pre&>;
         2 .....фрагмент кода....
         3 &<;/pre&>;

- Различных тагов в форме:

       @имя_тага [параметры тага]

Доступные таги для каждого объекта кода следующие:

- Классы

         @short [одна фраза текста]
           Краткое описание класса
         @author [одна фраза текста]
           Автор класса
         @version [одна фраза текста]
           Версия класса (Я обычно устанавливаю это равным RCS/CVS "Id" тага)
         @see [одна или несколько ссылок на классы и методы]
           Ссылки на связанную документацию.

- Методы

         @see
           см. выше
         @return [одна фраза текста]
           Фраза, описывающая возвращаемое значение
         @param [идентификатор имени параметра] [описание параметра]
           Описывает параметр. Может содержать несколько строк и прерывается
           пустой строкой, окончанием комментария или другим тагом параметра.
           Поэтому обычно располагается в конце комментариев.

- Константы, множества, свойства

         @see
           см. выше

- ALSO `@ref` Взято из формата документирования java. Метасимвол @ref имеет тот же формат, что и @see, но может встречаться в любом месте документации (остальные описания должны располагаться на той же строке, что и таг).