JAVA - 文档注释

文档注释

• 文档注释：对某个类、属性或者方法进行解释说明，增强代码可读性。注释的内容可被jdk提供的工具javadoc解析，生成以网页文件形式显示的某程序说明文档。
• 注意： 如果一个类想要使用javadoc工具生成开发者文档，那么这个类必须使用public修饰
• 格式：

/**
* ...
* ...
*
* @author kai
*
* @version 
* */

• 命令行演示javadoc生成说明文档

使用dos命令：javadoc -d命令，
使用格式：javadoc -d 存放路径 java源文件

（1）编写一个简单的java程序

/**
 * welcome!
 * hello!
 * 
 * @author kai
 * @version 2020-2-23
 * 
 */

public class Hello{
	public static void main(String[] args) {
		System.out.println("Hello.java! 你好啊~");
	}
	
}

（2）命令行输入：
javac Hello.java
javadoc -d myhello -author -version Hello.java
（3）打开index.html文件
红框中圈出的内容便是程序中的文档注释内容。