Java基础：生成JavaDoc文档的方法

Java Doc

javadoc命令是用来生成自己API文档的

参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

一、用命令行生成JavaDoc
1.在IDEA选择选择要操作的类

2.在上方的导航栏里输出cmd 调出命令行窗口

 3，输入代码javadoc -encoding UTF-8 -charset UTF-8  + 文件名

-encoding(编码) UTF-8 -charset（字符集） UTF-8 （防止乱码）

比如：

javadoc -encoding UTF-8 -charset UTF-8 ProvinceServiceImpl.java

或者

javadoc -d  路径 -version -author 类名(-version -author是你需要的信息)

比如：

javadoc     -encoding utf-8    -d     \\D:\javaweb\day23_redis\代码\day23_redis\src\cn\itcast\servic e   -version  -author      ProvinceService.java

（带上-encoding utf-8 ）      

 

要不然

4.再回去看文件

就会得到一个页面

用命令行生成JavaDoc文档的方法就完成了啦

 

二、用IDEA生成Doc文档
1.打开IDEA

2.

选择要操作的文件
输出的路径，记得是要在IDEA里创建的包
可以决定文档的语言，中文的就输入zh_CN
传入命令行的参数 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api（双引号内的生成的html页面标签的标题可自己定义）

3.点击确定后在IDEA左下角可以看到下图所示

4.在文件管理器里找到生成的html

生成的页面如下

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