主要来自于《尚硅谷Java教程》

目录

• JDK与JRE的区别
• 文档注释

JDK与JRE的区别

• JDK: 开发人员使用，包含Java开发工具和JRE，其中开发工具有编译工具(javac)、打包工具(jar)等。

• JRE: 想要运行Java程序，需要安装JRE，包括Java Virtual Machine (JVM) 和Java SE标准类库等。

文档注释

单行注释和多行注释内容不参与编译，即.class字节码文件中不包含被注释掉的信息。而文档注释是Java特有的工具，注释内容可以被JDK提供的javadoc工具解析，自动生成说明文档。使用步骤如下：

• 首先在.java中声明public类，然后写如下的文档注释：

/**
@author H.X.Meng
@version 1.0
这是关于文档注释的测试
*/
public class HelloWorld{
	/**
	main方法是程序的入口
	*/
	public static void main(String[] args){
		System.out.println("Hello world!!!");
	}
}

• 然后在终端输入如下命令（其中testDoc为生成文档的目录名，且由于有中文，需要使用UTF-8编码）：

javadoc -d testDoc -author -version -encoding UTF-8 -charset UTF-8 HelloWorld.java

• 打开testDoc/index.html，就能看到使用javadoc工具生成的文档。