第3章 Javadoc指令使用详细介绍

笑着哭i 提交于 2020-02-04 11:30:46

Javadoc指令使用详细介绍

java里面的注释分单行注释、多行注释和文档注释。这里重点讨论javadoc 指令的实际使用。

1.单行注释: 使用双斜线"//"放在需要注释的内容之前

2.多行注释:使用"/“注释开始,”/"注释结束。

在这里插入图片描述

3.文档注释:文档注释以"/**"开始,

​ 以"*/" 结束。

在这里插入图片描述

  • 下面使用三个简单的案例介绍如何使用javadoc工具生成API文档。

案例1:javadoc命令生成简单的API文档:

1)来到JavadocTest.java和Test.java所在的路径

文件内容如下:

在这里插入图片描述
在这里插入图片描述

2)执行以下命令

$ javadoc -encoding GBK -d apidoc -windowtitle 测试 -doctitle 使用javadoc工具生成API文档 -header 我的类 *Test.java

参数解释:

-encoding : javadoc执行时的编码指令,因为JavadocTest.java和Test.java中含有中文,所以要设置成GBK编码,否则会包“utf-8 不可编码”的错误

-d: 设置生成的API文档的路径,这里写“apidoc”会在当前路径处生成一个apidoc文件夹

-windowtitle:为api文档的浏览器窗口设置字符串标题。

-doctitle:用于指定概述页面的标题。

-header:包含每个页面的页眉。

运行成功后会在原路径生成一个apidoc文件夹,进入打开index.html页面,如下图。

在这里插入图片描述

案例2:javadoc命令生成更加详细的文档信息:

1)来到JavadocTagTest.java所在的路径

在这里插入图片描述

常用的javadoc标记如下:

@author: 指定Java程序的作者。

@version:指定源文件的版本。

@deprecated:不推荐使用的方法。

@see:“参数”,用于指定交叉参考的内容。

@param:方法的参数说明信息。

@return:方法的返回值说明信息。

@exception:抛出异常的类型。

@throws:抛出的异常和@exception同义。

2)执行以下命令

$ javadoc -encoding GBK -d apidoc -windowtitle 测试 -doctitle 使用javadoc工具生成API文档 -header 我的类 -version -author *Test.java
  • 上面的命令将会提取java源程序中的-author和-version两个标记的信息。除此之外,还会提取@param和@return标记的信息,结果如下图。

在这里插入图片描述

案例3:基于包结构生成API文档

该案例下包含两个包:

lee文件夹:包含JavadocTest.java文件,该java类的包是lee,对应的描述文件package.html

yeeku文件夹:包含Test.java和JavadocTagTest.java文件,java类的包是yeeku,对应的描述文件package.html

  • 文件内容,上面都已经展示过。

两个Package.html的内容分别是:

​ “lee包描述”

​ “yeeku包描述”

1)来到package\文件夹下:

在这里插入图片描述

2) 执行如下命令

$ javadoc -encoding GBK -d apidoc -windowtitle 测试 -doctitle 使用javadoc工具生成API文档 -header 我的类 -version -author lee yeeku

生成的API文档如下:

在这里插入图片描述

  • Javadoc 工具会自动把给定文件路径的多个文件组合生成一个API文档。

关于标识符和关键字

1)Java的所有关键字都是小写;

2)java提供了三个直接量true,flase,null;

3)java语言是强类型语言:所有的变量必须先声明、再使用;指定类型的变量只能接受与之匹配的值;

4)引用数据类型就是对一个对象的引用。实际上,引用类型变量就是一个指针,只是java不再使用指针这个说法。

5)空引用(null)只能被转换成引用类型;

6)字符串不是基本数据类型,字符串是一个类String,是一个引用类型;

7)java的基本数据类型:

在这里插入图片描述

byte: 一个byte类型整数在内存中占用8位,表数范围是:-128(-2^7) ~ 128(2^7-1)

8)当计算机要保存某个字符时,只要将该字符的编码转换为二进制码,然后保存起来即可;

9)ASCII字符集,只要一个字节(8位,支持256个字符编号)即可为所有字符编码;

10)Unicode字符集,则是用了两个字节(16位,支持65536个字符编号);

11)char类型的值可直接作为整型值来使用,它相当于一个16位的无符号整数,表数范围是0-65535;

12)负无穷大:Double.NEGATIVE_INFINITY; 正无穷大:Double.POSITIVE_INTINITY; 非数:NaN;

13)boolean类型的数值只能是true或false,不能用0或非0表示;

14)把任何基本类型的值和字符串值进行连接运算时,基本类型的值将自动类型转换为字符串类型;

15)强制类型转换格式:(targetType)value

16)错误写法:float a=5.6; 因为5.6默认是double类型; 正确写法: float a=(float)5.6;

17)Java八种基本类型都提供了对应的包装类:实现将字符串转换成对应的基本类型;

boolean — Boolean

byte — Byte

short — Short

int — Integer

long — Long

char — Character

float — Float

double — Double

以上8个包装类都提供了一个parseXxx静态方法用于将字符串转换成基本类型;

18)整个算数表达式的数据类型自动提升到与表达式中最高等级操作数同样的类型;

19)null, 这个直接量可以赋给任何引用类变量,用以表示这个引用类型变量中的保存的地址为空;

20)常量池:指的是编译期间(生成.class时)被确定的值如 : 常量值,字符串;

21)更复杂的运算符,借助于java.lang.Math:

次方: Math.pow(a, 5)

平方根:Math.sqrt(a)

随机数:Math.random()

sin函数值:Math.sin(1.57)

22)位运算操作符只能操作整数类型的变量或值;

23)|| 短路或 — | 不短路或 ; && 短路与 — & 不短路&

短路指的是,对于逻辑运算符前后连个表达式,若前面的表达式满足“与或”操作,则后面的表达式不用操作。

不短路是指,不管如何前后两个表达式都会执行;

参考书籍:《疯狂Java讲义 》李刚;

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!