4. javadoc.exe文档生成注释

1、单行注释：//

2、多行注释：/开头，/结束

3、文档注释：/**开头，*/结束

注：文档注释不仅可以起到注释的作用，bin目录下的javadoc.exe(文档生成工具)还可以帮助我们生成一个帮助文档，以后不管是自己查看这段代码，还是别人查看这段代码，都可以很清晰知道这个程序写的是什么，什么时候写的，作者是谁。

注释中也不能有语法错误，否则不能通过javac的编译。

注：十六进制是uniconde转义，必须是四位整数写全，不够四位整数的，在最前面用0补齐。例：\u61 必须写成 \u0061。写十六进制注释的时候也必须是四位整数（原因是：编译器是先识别\u61 后，再丢弃注释的，假如\u61出现语法错误，就会显示语法错误）

把\u41改为\u0041后，就可以表示正确的注释了。

4、javadoc.exe文档注释生成器

只有在声明类，声明主方法的时候，编译器才可以识别是“文档注释”；否则，只会被认为是多行注释。(很重要，并不是什么地方都可以写文档注释)

Ⅰ 常见的javadoc标记

Ⅱ 生成帮助文档

Demo1.java源代码如下：

/**
这是一个示例类：示例代码
@author Huang Wei
@version 1.0 2019 - 10 - 7
*/
public class Demo1 {
    	/**
    	这是一个获得一个整数的方法
    	@return 返回任意的一个整数
    	@see Demo#value
	*/
	public int getValue(){
		return 11;
	}
	/**
	这是一个主方法，程序的入口
	@param args 字符串，字符序列
	@throws 异常，问题的解决方式
	*/
	public static void main(String[] args) throws Exception{
		System.out.println("Hello World");
	}
}

class Demo{
	/**
	这是一个值
	*/
	public void value(){}
}

day01目录下，目前没有doc这个目录。

打开CMD黑窗口。去到执行代码的文件目录下（Demo1放在day01下），执行以下代码：

javadoc -d -author -version doc Demo1.java
# -d  doc表示生成的文档说明，放在这个文件夹doc中(没有会自动创建)
# -author -version写了这两个参数，才能解析代码中的author和version
# Demo1.java是执行文件

结果如下。但是一直提示这个错误。目前还没有找到解决办法。

虽然报错了，但是仍然生成了帮助文档。

可以看看，doc下有哪些内容。

然后我们打开这个Demo1.html网址。部分截图如下：

Ⅲ 代码中public有时候会写成如下几种方式(目前不知道啥意思)

-public         只解析public
-protected      解析public，protected
-package        解析public，protected，默认
-private        解析public，protected，默认，私有

注：当代码上面写的是public，我们可以用如下代码生成帮助文档：

javadoc -private -d doc Demo1.java

当public变为-protected -package -private中任何一个，我们再使用上述方式生成帮助文档，就会报错，因此我们可以使用各自对应的解析方式。