-
- All Known Subinterfaces:
-
ParamTag
,SeeTag
,SerialFieldTag
,ThrowsTag
@Deprecated(since="9", forRemoval=true) public interface Tag
Deprecated, for removal: This API element is subject to removal in a future version.The declarations in this package have been superseded by those in the packagejdk.javadoc.doclet
. For more information, see the Migration Guide in the documentation for that package.表示一个简单的文档标记,例如@since,@ author,@ version。 给定标签(例如“@since 1.2”),保持标签名称(例如“@since”)和标签文本(例如“1.2”)。 具有结构或需要特殊处理的标签由子类处理,例如ParamTag(用于@param),SeeTag(用于@see和),以及ThrowsTag(用于@throws)。- 另请参见:
-
SeeTag
,ParamTag
,ThrowsTag
,SerialFieldTag
,Doc.tags()
-
-
方法摘要
所有方法 实例方法 抽象方法 弃用的方法 变量和类型 方法 描述 Tag[]
firstSentenceTags()
不推荐使用,要删除:此API元素将在以后的版本中删除。将注释的第一句作为标记数组返回。Doc
holder()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此Tag元素的包含Doc
。Tag[]
inlineTags()
不推荐使用,要删除:此API元素将在以后的版本中删除。对于嵌入了{@link}
标记的文档注释,返回一个Tag
对象的数组。String
kind()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此标记的类型。String
name()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此标记的名称。SourcePosition
position()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此标记的源位置。String
text()
不推荐使用,要删除:此API元素将在以后的版本中删除。返回此标记的文本,即标记名称之外的部分。String
toString()
不推荐使用,要删除:此API元素将在以后的版本中删除。将此对象转换为字符串。
-
-
-
方法详细信息
-
name
String name()
Deprecated, for removal: This API element is subject to removal in a future version.返回此标记的名称。 名称是以“@”开头的字符串,用于文档注释,例如@return
。 对于内联标记,例如{@link}
,大括号不是名称的一部分,因此在此示例中,名称将简单地为@link
。- 结果
- 这个标签的名称
-
holder
Doc holder()
Deprecated, for removal: This API element is subject to removal in a future version.返回此Tag元素的包含Doc
。- 结果
-
包含此Tag元素的
Doc
-
kind
String kind()
Deprecated, for removal: This API element is subject to removal in a future version.返回此标记的类型。 对于大多数标签,kind() == name()
; 下表列出了存在多个给定类型的标记的情况: Related Tagsname()
kind()
@exception
@throws
@link
@see
@linkplain
@see
@see
@see
@serial
@serial
@serialData
@serial
@throws
@throws
- 结果
- 这个标签的种类。
-
text
String text()
Deprecated, for removal: This API element is subject to removal in a future version.返回此标记的文本,即标记名称之外的部分。- 结果
- 这个标签的文字
-
toString
String toString()
Deprecated, for removal: This API element is subject to removal in a future version.将此对象转换为字符串。
-
inlineTags
Tag[] inlineTags()
Deprecated, for removal: This API element is subject to removal in a future version.
-
firstSentenceTags
Tag[] firstSentenceTags()
Deprecated, for removal: This API element is subject to removal in a future version.将注释的第一句作为标记数组返回。 包括内联标记(即{@link reference }标记),但不包括块标记。 纯文本的每个部分表示为“文本”的Tag
。 内联标记表示为“@link”的SeeTag
。 如果语言环境是英语,则第一句话由Java语言规范(第一版)中描述的规则确定:“此句在第一个句点结束,后面是空格,制表符或行终止符或第一个句点另外,一行将以段落和段落终止HTML标记终止:<p> </ p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>或</ pre>。 如果区域设置不是英语,则句子结束将由BreakIterator.getSentenceInstance(Locale)
确定。- 结果
-
表示注释第一句的
Tag
个对象的数组
-
position
SourcePosition position()
Deprecated, for removal: This API element is subject to removal in a future version.返回此标记的源位置。- 结果
- the source position of this tag.
-
-