0基础java入门：第六节.Java中的注释

第六节.Java中的注释

注释是什么?

注释是java代码中不可或缺的一个部分，注释的作用是用来表述代码的功能说明和注意事项等等。被注释代码部分是不会执行的但是会编译。Java的注释有三种，分别是单行注释，块注释和文档注释。

下面我们一起来了解以下这三种注释。

1.单行注释

单行注释：顾明思议这中注释只能注释一行，符号是  // 符号后的一行属于注释区域。使用方式如下

public class HelloWorld{ // 注释内容 
	public static void main(String[] args){// 注释内容 
		System.out.println("第一个JAVA程序");// 注释内容 
	}// 注释内容 
}// 注释内容

2.多行注释

多行注释也叫块注释：块注释的符号是 /* 开始 ， */ 结束。注释的范围就是 /*和*/之间的内容。如下

public class HelloWorld{ 
	public static void main(String[] args){ 
		/*注释内容*/
		System.out.println("第一个JAVA程序");
		/*
			注释内容
		*/
	} 
} 

3.文档注释

文档注释：文档注释 是以 /** 开始 */ 结束。注释的区域和块注释相同。一般放在方法和类上，用来说明类和方法的功能，参数，返回值，编写时间等信息。并且文档注释是可以通过javadoc命令生成类的API手册说明。如下：

尽量新建一个文件夹之后新建一个HelloWorld.java文件 书写如下代码

/**
 * <p>Title: </p>
 * <p>Description: </p>
 * <p>Company: </p>
 * @author 你的名字
 * @date ${date} ${time}
 * @版本 V 1.0 
 * ${tags}
 */
public class HelloWorld{ 
/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(这里用一句话描述这个方法的作用)
 * @param: ${tags}   
 * @return: ${return_type}   
 * @throws
 */
	public static void main(String[] args){ 
		System.out.println("第一个JAVA程序");
	} 
}

书写后保存编译并且执行。

编译执行成功后，再次使用 javadoc HelloWorld.java ，控制台会输出一大堆的信息，同时文件所在的文件夹中会生成好多文件。

执行完成后可以先忽略这些错误和警告，查看文件所在的文件夹。

之后使用 浏览器打开 index 页面可以查看说明文档。

写在最后：注释最终要的目的就是给代码添加说明，方便之后的代码维护。也不是注释多就好。关键部位进行说明就可以。我们在后边的学习的过程中也会在代码中进行一些说明和标记时使用注释。