JavaDoc


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


参数信息

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



DOS命令生成JavaDoc文档


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


IDEA生成JavaDoc文档

打开 idea，点击 Tools-> Generate JavaDoc，这样会打开生成 javadoc 文档的配置页面。
进行配置：



手把手教你使用idea生成漂亮的javadoc文档

免费学习网站：https://www.kuangstudy.com/

1、java帮助文档也就是JDK帮助文档就是由javadoc生成的

Javadoc常用的标识：@author @version @since @param @return @throws

JavaDoc
javadoc命令是用来生成自己API文档的
参数信息：
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

1.什么是javadoc？

javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。javadoc命令是用来生成自己API文档的，使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
2.javadoc注释规范。

一、 Java文档
// 注释一行

/ *    / 注释若干行

/*   ……*/  注释若干行，写入Javadoc文档
二、文档格式

写在类上的文档标注一般分为三段：
第一段：概要描述，通常用一句话或者一段话简要描述该类的作用，以英文句号结束

第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束

第三段：文档标注，用于标注作者，创建时间，参阅类等信息