Java之文档注释基本使用

文章目录

• 1. 文档注释
• 2. 常见 javadoc 标签

1. 文档注释

• 注释内容可以被JDK提供的工具javadoc所解析，生成一套以网页文件形式体现的该程序的说明文档，一般写在类中。
• 基本格式

javadoc -d 文件夹名 -xx -yy Demo1.java

xx,yy表示java代码里用到的 javadoc 标签，如：@author，@version

• 应用实例

/**
 * @author xdr630
 * @version 1.0
 */
public class Comment1 {
    public static void main(String[] args) {
		
    }
}

javadoc -d D:\JavaSE_Test\temp -author -version Comment1.java

• 打开 index.html
  
  

2. 常见 javadoc 标签

• javadoc 工具软件识别以下标签：