一、Java中的注释类型
- 单行注释
- 多行注释
- 文档注释
二、格式
(1)、单行注释
格式: // 注释文字
(2)、多行注释
格式: /* 注释文字 */
被注释的文字,不会被JVM解释执行;多行注释里面不允许有多行注释嵌套。
(3)、文档注释
注释内容可以被JDK提供的工具javadoc
所解析,生成一套以网页文件形式体现的该程序的说明文档,一般写在类
格式:javadoc -d 文件夹名 -xx -yy Demo.java
例如有如下源代码:
// 文档注释
/**
* @author 小汤
* @version 1.0
*/
public class JavaDocCom{
// 编写一个main方法
public static void main(String[] args){
// 计算两数之和
int n1 = 20;
int n2 = 100;
int sum = n1 + n2;
System.out.println("两数之和为: " + sum);
}
}
在cmd中输入:
javadoc -d e:\\Temp -author -version JavaDocCom.java -encoding utf-8
就会在E盘的Temp文件夹下生成对应的网页文件。