Idea 快速生成 JavaDoc文档

• Javadoc的定义

• javadoc  是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过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

在项目中我们使用  javaDoc注释 /** */

• 在类上

/**
 * @author aux
 * @version 版本1.1 
 */

• 在方法上

/**
 * 描述
 *
 * @param 参数
 * @return 返回
 */

• Javadoc的生成

   在ider里打开 Tools工具栏，

   

 

   点击左侧项目，再去点Generate java Doc

生成文件范围

Module  项目名

Directory 指定文件目录

Output directory 是生成之后的文件夹

勾选变量修饰符作用域展示，默认是 protected ,public  这些是过滤修饰符(方法或变量、类有这些修饰符可以加入文档中)，右侧 @**  是javaDoc 注释下的别名

Maximum heap size    最大堆栈大小

Include test sources  是否包含测试类

othercommand line arguments: -encoding UTF-8 -charset UTF-8  UTF编码

Open generated documentation in browser 在浏览器打开文档

生成之后打开 index.html

发现标题是生成的文档(无标题)，这时我们编辑index.html文件，修改<title>标签即可