Java之JavaDoc标签

javadoc工具软件识别以下标签：

标签	描述	示例
@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

需要注意这些标记的使用是有位置限制的：

可以出现在类或者接口文档注释中的标记有：@see、@deprecated、@author、@version等。
可以出现在方法或者构造器文档注释中的标记有：@see、@deprecated、@param、@return、@throws、@exception等。
可以出现在文档注释中的标记有：@see、@deprecated等。

使用javadoc注释，生成API文档的方法：

点击整个工程，右键点击Export，选择Java下的Javadoc，点击Next，Configure选择jdk安装路径下的\bin\javadoc.exe，Browse选择生成的API文档的存放位置，点击Finish，点击Yes To All

Java之JavaDoc标签相关推荐

Javadoc （Java API 文档生成器）详解 [Javadoc 概述][Javadoc 标签][Javadoc 命令][Javadoc 生成 API 文档]
您的"关注"和"点赞",是认可,是支持,是动力. 如意见相佐,可留言. 本人必将竭尽全力试图做到准确和全面,终其一生进行修改补充更新. 文章目录 1 Javad ...
java弃用标签_Java 9 揭秘（15. 增强的弃用注解）
Tips 做一个终身学习的人. 主要介绍以下内容: 如何弃用API @deprecate Javadoc标签和@Deprecation注解在弃用的API中的角色用于生成弃用警告的详细规则在JDK ...
jdk10 换成jdk8_JDK 10的摘要Javadoc标签
jdk10 换成jdk8 JDK 10通过发行JDK-8173425 引入了Javadoc标签{@summary} (" Javadoc需要一个新标签来指定摘要."). 这个新标签 ...
javadoc 标签_新的Javadoc标签@ apiNote，@ implSpec和@implNote
javadoc 标签如果您已经在使用Java 8,则可能会看到一些新的Javadoc标签: @apiNote , @implSpec和@implNote . 他们怎么了? 如果要使用它们,该怎么办? ...
JDK 10的摘要Javadoc标签
JDK 10通过发行JDK-8173425 引入了Javadoc标签{@summary} (" Javadoc需要一个新标签来指定摘要."). 这个新标签允许开发人员显式指定Jav ...
在 IntelliJ IDEA 中误添加自定义的 JavaDoc 标签，如何删除
在 IntelliJ IDEA 中误添加自定义的 JavaDoc 标签,如何删除运行环境: IntelliJ IDEA 2020.1.2 (Ultimate Edition) 笔者使用 Inte ...
java过滤html标签获取纯文本信息
转载自 java过滤html标签获取纯文本信息 package com.lyt.base.util;import java.util.regex.Pattern;public class Filter ...
java中解释命令_闲来无事可来了解下Java中Javadoc命令的用法
[javadoc命令的用法] 1.java源文件里,注释以/**开始并以*/结束,里面可以包含普通文件,HTML标记和javaDoc标记.这些将构成javaDoc文档. 2.javadoc命令只能处 ...
html标签转换字符类型,java把html标签字符转换成普通字符(反转换成html标签)
package net.jasonjiang.web; import org.junit.Test; import org.springframework.web.util.HtmlUtils; /* ...

Java之JavaDoc标签

Java之JavaDoc标签相关推荐

最新文章

热门文章