Java注释和c/c++一样有单行注释和多行注释,不同的是java还有一个文档注释。
单行注释使用方法如下,在当前行以//开始的内容都不会参与程序的编译,会被java编译器直接忽略掉。
package HelloWorld;
public class HelloWorld {
//主程序入口
public static void main(String[] args) {
//控制台打印语句
System.out.println("Hello World!");
}
}
多行注释使用方法如下,在任意行以/*开始到任意行以*/结束的内容都为注释内容,这些内容不会参与程序编译,另外多行注释不能嵌套,总是最先出现的/*与最先出现*/相匹配。
package HelloWorld;
public class HelloWorld {
//主程序入口
public static void main(String[] args) {
//控制台打印语句
System.out.println("Hello World!");
/*
for(int i=0;i<999999999999999999L;i++){
System.out.println("Hello World!");
}
*/
}
}
文档注释使用方法如下:
package HelloWorld;
public class HelloWorld {
/**
* 使用文档注释
* @param args
* @author Kaker
* @version 0.0
*/
//主程序入口
public static void main(String[] args) {
//控制台打印语句
System.out.println("Hello World!");
/*/*
for(int i=0;i<999999999999999999L;i++){
System.out.println("Hello World!");
}
*/*/
}
}
它以/**开始到任意行以*/结束的内容都为注释内容,如果源文件里有文档注释那么就可以使用JDK二进制目录下的javadoc.exe来生成html格式的说明文档,这样我们在写API说明文档的时候就可以这样来生成之后再稍加修改就可以了。
javadoc.exe再CMD下的使用方法如下:
javadoc -d ./ -encoding UTF-8 HelloWorld.java
-d后面接的是要生成文档的存放目录此处./表示当前目录。
-encoding后面接的是生成文档的编码方式,此处采用UTF-8编码。
此处的HelloWorld.java是写有文档注释的java源代码文件,表示要对该文件生成说明文档。