## Javadoc的定义与使用

Javadoc的定义与使用

一、定义
Javadoc是从程序源代码中抽取类、方法、等注释形成一个自己的API帮助文档,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。Javadoc用于描述类或者方法的作用。
二使用
(1)常用标记## Javadoc的定义与使用
(2)写在类上面的javadoc
1.概要描述:通常用一句话或一段话描述作用,以英文句号结束
2.详细描述:用一句话或多段话描述该方法作用,一般以英文句号结束
3.文档标注用于标注参数、返回值、异常、参阅等。

详细描述上经常使用html标签来,通常都以p标签开始,而且p标签通常都是单标签,不使用结束标签,其中使用最多的就是p标签和pre标签,ul标签, i标签。
(3)命令格式 javadoc [选项] [软件包名称] [源文件]
选项有
## Javadoc的定义与使用