一、Java的3种注释形式
注释就是对代码进行解释,并不会被编译、执行,主要目的是为了让别人更好的理解代码。
1、单行注释:以两个斜杠 //
开头的注释被视为单行注释,这种注释方式只注释当前行的代码。
// 这是一个单行注释
2、多行注释:以斜杠和星号 /*
开头,以星号和斜杠 */
结尾的注释被视为多行注释。这种注释方式可以跨多行注释代码,但不能嵌套。
/*
* 多行注释
* 这是第2行注释
*/
3、文档注释:以斜杠和两个星号 /**
开头的注释被视为文档注释。
文档注释可以用于生成 API 文档,并且可以包含HTML标记。文档注释一般用于类、方法或接口的说明文档
/**
* @author qicong
* @version v1.0
* 这是文档注释,可以使用@标签
* 写在类和方法的前面
*/
生成文档命令格式
javadoc Demo.java -encoding UTF8 [-d C:\\demo\\]
好的代码不需要注释,所以要保存良好的编码习惯,不要滥用注释;
如果需要写注释,那么注释尽量简洁明了,更多的时候使用单行注释;
二、文档注释标签
