@Param
Тег @Param может архивировать один параметр метода или конструктора или типа параметров класса архива, интерфейса и общих методов. При использовании тега @Param мы должны использовать один из тегов для каждого параметра метода. Первое слово в каждом абзаце будет рассматриваться как имя параметра, в то время как остальное будет рассматриваться как описание:
@Param Макс максимальное количество слов для чтения.
При архивировании параметров, мы должны добавить <и> к обеим сторонам названия параметра типа:
@Param 体中国中国中国中国
Тем не менее, параметры типа обычно не требуют явной документации, так как все они очень очевидны.
@ видеть
Теги @see могут создавать перекрестные ссылки, связанные с другими документами Javadoc. Мы можем назвать любые идентификаторы после тега, хотя мы должны полностью их квалифицировать. Например, он обычно может быть назван с простой именем члена класса, но если член является перегруженным методом, мы должны указать перегруженную версию метода, перечисляя типы каждого параметра. Мы можем использовать неквалифицированное имя для указания интерфейса или класса в текущем пакете, но мы должны использовать полностью квалифицированное имя для указания типов в других пакетах. Мы можем указать участников типа, используя # перед именем участника. Вот все действительные @ См. Форматы тегов:
@see #getName @see Attr @see com.magic.attr.Attr @see com.magic.attr.Deck#DECK-SIZE @see com.magic.attr.Attr#getName @see com.magic.attr.Attr#Attr(String) @see com.magic.attr.Attr#Attr(String) @see com.magic.attr.Attr#Attr(String, Object) @see com.magic.attr @see атрибут Спецификация @see "Альманак разработчика Java" Almanac "
Первая форма относится к методу, называемому GetName, который находится в том же классе или интерфейсе, что и сама аннотация документа, или в определенном окружающем классе или окружающем интерфейсе. Такой синтаксис также может быть применен к конструкторам и полям. Вторая форма относится к классу в текущем пакете или классе в определенном пакете руководства. Третья форма относится к классу с использованием полностью квалифицированного имени.
Последние 4 формы @See ссылаются на участников, где первые два посвящены доменам (Deck-Siz Day и Method (GetName). Мы можем непосредственно использовать имя метода, потому что только один метод GetName определяется в классе ATTR. Последние две формы относятся к конструктору класса ATTR, один из которых принимает цитаты строки, а другая, которая принимает на выгрузку, которые нагружены, которые нагружены, которые нагружены, которые нагружены. Мы хотим обратиться.
Следующая форма @see приводит читателя к конкретному пакету: com.magic.attro
Последние две формы позволяют нам цитировать другие документы. Среди них предыдущий использует для определения ссылки, а последний использует кавычки, чтобы приложить имя документа. Мы можем использовать обе формы для направления читателя на другие документы, такие как полное руководство.
Форма @see (все формы, кроме двух последних форм выше), которые называют языковую сущность, может сопровождаться меткой. В сгенерированном документе это имя этикетки заменит имя объекта. Например:
@ См. #GetNameATtribute имена
Будет создана ссылка на документ GetName, но текст, который он отображает, является «именами атрибутов» вместо «GetName». Обычно мы должны использовать настоящие имена членов, но показанные здесь функции иногда полезны.