public interface Tag
SeeTag
, ParamTag
, ThrowsTag
, SerialFieldTag
, Doc.tags()
Модификатор и Тип | Метод и Описание |
---|---|
Тег[] |
firstSentenceTags()
Возвратите первое предложение комментария как массив тегов.
|
Документ |
holder()
Возвратите содержание
Doc из этого элемента Тега. |
Тег[] |
inlineTags()
Для комментария для документации со встроенным
{@link} теги, возвратите массив Tag объекты. |
Строка |
kind()
Возвратите вид этого тега.
|
Строка |
name()
Возвратите имя этого тега.
|
SourcePosition |
position()
Возвратите исходную позицию этого тега.
|
Строка |
text()
Возвратите текст этого тега, то есть, части вне имени тега.
|
Строка |
toString()
Преобразуйте этот объект в строку.
|
String name()
@return
. Для встроенных тегов, такой как {@link}
, фигурные скобки не являются частью имени, таким образом, в этом примере имя было бы просто @link
.String kind()
kind() == name()
; следующая таблица приводит те случаи, где есть больше чем один тег данного вида:
kind() | name() |
---|---|
@throws | @throws |
@throws | @exception |
@see | @see |
@see | @link |
@see | @linkplain |
@serial | @serial |
@serial | @serialData |
String text()
String toString()
Tag[] inlineTags()
{@link}
теги, возвратите массив Tag
объекты. Весь комментарий документа разламывается на строки, разделенные {@link}
теги, где каждый последовательный элемент массива представляет или строку или {@link}
тег, в порядке, от запуска, чтобы закончиться. Каждая строка представляется a Tag
объект имени "текст", где text()
возвращает строку. Каждый {@link}
тег представляется a SeeTag
из имени "@link" и вид "@see". Например, учитывая следующий тег комментария:
This is a {@link Doc commentlabel} example.
возвратите массив объектов Тега:
Tag[] firstSentenceTags()
Tag
из доброго "текста". Встроенные теги представляются как a SeeTag
из вида "@link". Если локаль является английским языком, первое предложение определяется правилами, описанными в Спецификации языка Java (первая версия): "Это предложение заканчивается в первый период, который сопровождается пробелом, вкладкой, или разделителем строки или в первом tagline.", кроме того, строка будет завершена абзацем и разделом, завершающим HTML-тэги: <p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <час> <пред> или </пред>. Если локаль не будет английской, то конец предложения будет определен BreakIterator.getSentenceInstance(Locale)
.Tag
объекты, представляющие первое предложение комментарияSourcePosition position()
Java является торговой маркой или зарегистрированной торговой маркой Oracle и/или его филиалов в US и других странах.
Авторское право © 1993, 2013, Oracle и/или его филиалы. 500 Бульваров Oracle
Берега красного дерева, Калифорния 94065 США. Все права защищены.
Проект сборка-b92