java中的注释包括了我们常见的单行注释以及多行注释,单行与多行注释不再赘述。
这里主要学习一下java中的文档注释以及通过使用javadoc来让文档注释输出为文档。
这里先来讲一讲什么是文档注释,文档注释通过/***/
来标注,使用的方法是/**+enter
。文档注释可以放在类、方法、成员变量、接口的前面来说明它们的功能,比如放在方法的前面:
javadoc可以从源码中抽取类、方法、变量之前的注释,将其整理为一个属于自己代码的API帮助文档。
注意
-pravite
。所谓标签,就是javadoc能识别的注释中的特殊部分,这些标签都由@
开头或者是以{@}
的形式存在。
常见的一些标签如下所示:
标签 | 描述 |
---|---|
@author | 作者名 |
@version | 版本号 |
@since | 指明需要最早使用的jdk版本 |
@param | 参数 |
@return | 返回值情况 |
@throws | 异常抛出情况 |
注意
javadoc的命令用法标准是
javadoc + 命令参数 + 包名 + 源文件名
我们通过javadoc命令将上面的helloworld的java文件生成文档:
回到我们项目的文件夹中,我们发现了很多.html文件,我们打开index.html文件可以发现,javadoc提取出了我们的文档注释,并生成了我们的API帮助文档目录:
首先在顶部菜单中点击Tool,然后选择Generate JavaDoc
进入配置页面后进行参数的配置
点击OK
之后会自动在我们指定的目录导出我们的Javadoc文档:
数据类型:boolean、int、long、short、byte、float、double、char、class、interface。
流程控制:if、else、do、while、for、switch、case、default、break、continue、return、try、catch、finally。
修饰符:public、protected、private、final、void、static、strict、abstract、transient、synchronized、volatile、native。
动作:package、import、throw、throws、extends、implements、this、supper、instanceof、new。
保留字:true、false、null、goto、const。
JAVA区分大小写,是强类型语言
Java的数据类型分为两大类: