JAVA学习笔记02-注释、标识符、关键字以及数据类型

目录

注释

java中的注释包括了我们常见的单行注释以及多行注释,单行与多行注释不再赘述。
这里主要学习一下java中的文档注释以及通过使用javadoc来让文档注释输出为文档。
这里先来讲一讲什么是文档注释,文档注释通过/***/来标注,使用的方法是/**+enter。文档注释可以放在类、方法、成员变量、接口的前面来说明它们的功能,比如放在方法的前面:
JAVA学习笔记02-注释、标识符、关键字以及数据类型

Javadoc

javadoc可以从源码中抽取类、方法、变量之前的注释,将其整理为一个属于自己代码的API帮助文档。

注意

  • 文档注释需要放到类、方法、接口、变量的前面,因为javadoc只处理在这些位置前的注释。
  • 所谓的API是暴露给用户使用的部分,所有Javadoc默认只会提取public和protected修饰的部门,如果需要提取pravite部分的注释,那么就需要加上-pravite

Javadoc的标签

所谓标签,就是javadoc能识别的注释中的特殊部分,这些标签都由@开头或者是以{@}的形式存在。

常见的一些标签如下所示:

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

注意

  • Javadoc的标签是区分大小写的,如果大小写不对,在生成帮助文档的时候会检测不到
  • Javadoc必须从一行的开头书写,这是约定。

用Javadoc命令生成文档

javadoc的命令用法标准是

javadoc + 命令参数 + 包名 + 源文件名

我们通过javadoc命令将上面的helloworld的java文件生成文档:
JAVA学习笔记02-注释、标识符、关键字以及数据类型
回到我们项目的文件夹中,我们发现了很多.html文件,我们打开index.html文件可以发现,javadoc提取出了我们的文档注释,并生成了我们的API帮助文档目录:
JAVA学习笔记02-注释、标识符、关键字以及数据类型

用IDEA生成Javadoc文档

首先在顶部菜单中点击Tool,然后选择Generate JavaDoc
JAVA学习笔记02-注释、标识符、关键字以及数据类型

进入配置页面后进行参数的配置
JAVA学习笔记02-注释、标识符、关键字以及数据类型
点击OK之后会自动在我们指定的目录导出我们的Javadoc文档:
JAVA学习笔记02-注释、标识符、关键字以及数据类型

JAVA的关键字

数据类型: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的数据类型

Java的数据类型分为两大类:

  • 基本类型(primitive type)int、long、float、boolean......
  • 引用类型(reference type)包括类、接口、数组
上一篇:Java(五)Javadoc生成文档


下一篇:第4章 注释