Java注释的简单理解

每种编程语言的语法规范中都包含了注释的规则，从早期的C到近些年的Python大体上各种语言的注释要求都类似。良好的注释习惯会让别人很轻松地阅读你的代码，同时，也让自己的编程过程中的想法有了准确的记录，下面就我最近学习的Java语言，与大家分享一下我的理解。

 在Java中有3种类型的注释，分别是单行注释、多行注释和文档注释。

1.单行注释

单行注释的作用是注释一行代码。它是使用双斜线（//）标注的，注释的内容放在“//”的后面。

//注释内容

2.多行注释

如果我们想同时注释连续的多行代码，可以使用多个单行注释。但是这种方式太过繁琐，我们可以直接使用多行注释的方式。 多行注释的作用是注释连续的多行内容。它把注释的内容放在“/*”开始，“*/”结束的区域内。这其中的一切内容均属于注释部分，不用做代码处理。

/* 多
   行
   注
   释
*/

3.文档注释

单行注释和多行注释是大多数程序语言共有的，Java语言在二者之上还有自己独有的文档注释。 文档注释的好处是将分离的代码和注释连接起来，保证代码与注释内容可以同时更新。除此之外，文档注释还可以生成API文档。

 文档注释以“/**”开始，“*/”结束，中间的内容全部都是文档注释。

/**
文档注释
*/

不过，要想保证代码与注释同时更新，仅使用“/** ”、“*/”这两个符号是不够的，还要使用到文档注释的标签，也可以称为“标记”。文档注释的标记是什么、完整的文档注释应该怎么编写、如何将文档注释生成API见“2.文档注释生成API文档”。下面是3种注释的示例。

package study._cqf;
/**
 * 主题：Java中的注释
 *
 * @author Congqiufeng
 * 
 */
 
public class study {
	/**
	 * 【文档注释】
	 * @param 字符串数组
	 * @return void类型
	 */
	public static void main(String[] args) {
		/*
		 * 【多行注释】
		 * System类字段out
		 */
		System.out.println("Hello World!");//【单行注释】输出内容为Hello World!
	}
}