编程语言
首页 > 编程语言> > JavaDoc文档生成

JavaDoc文档生成

作者：互联网

JavaDoc文档

JavaDoc是Sun公司提供的一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API

注释标签

标记说明标签类型
@author 作者 作者标识 包、类、接口
@version 版本号 版本号 包、类、接口
@param 参数名 描述 方法的入参名及描述信息，如入参有特别要求，可在此注释。 构造函数、方法
@return 描述 对函数返回值的注释 方法
@deprecated 过期文本 标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在．以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、方法
@throws 异常类名 构造函数或方法所会抛出的异常。 构造函数、方法
@exception 异常类名 同@throws 构造函数、方法
@see 引用 查看相关内容，如类，方法，变量等。 包、类、接口、值域、构造函数、方法
@since 描述文本 API在什么程序的什么版本后开发支持。 包、类、接口、值域、构造函数、方法
{@link 包.类#成员 标签} 链接到某个特定的成员对应的文档中。 包、类、接口、值域、构造函数、方法
{@value} 当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。 静态值域

此外还有@serial、@serialField、@serialData、{@docRoot)、{@inheritDoc)、{@lteral})、{@code} {@value arg}几个不常用的

命令行生成JavaDoc文档

  1. 在资源管理器中打开想要生成JavaDoc文档的java文件目录


     

  2. 在地址栏前面输入cmd+空格+回车打开命令行窗口


  3. 在窗口输入javadoc -encoding utf-8 -charset utf-8 java文件，回车 


IDEA生成JavaDoc文档

  1. 打开IDEA，点击Tools >> Generate JavaDoc，打开生成JavaDoc文档的配置页面 



  2. 进行配置 


　　　　　　　　　注释:

序号解释
1 文档生成范围
2 文档输出路径
3 文档生成语言
4 传入JavaDoc的参数，一般这样写 -encoding utf-8 -charset utf-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/8/docs/api

 

  1. 按要求填写好后点击OK

标签：值域,JavaDoc,生成,文档,方法,构造函数
来源： https://www.cnblogs.com/yanglf-blog/p/14354643.html