Java中的注释

一、Java中的注释（comment）

注释的作用：对编写的代码提供解释说明，提高代码的阅读效率；调试所写代码（注释的内容不参与编译）。

1、单行注释

单行注释直接在需要注释的行前边加上双斜线（阿里开发手册规定在双斜线后有且只能有一个空格）。例如下图：

public class HelloWord {
	// 单行注释：main函数，程序的入口
	public static void main(String[] args){
		System.out.print("hello word!");
	}
}

2、多行注释

多行注释可以注释掉多行内容，注释写法如下图：

public Class HelloWord {
	/* 
	多行注释：
	main函数，
	程序的入口，
	*/
	public static void main(String[] args){
		System.out.print("hello word!");
	}
}

3、文档注释

文档注释是Java语言所特有的，文档注释可以被JDK提供的javadoc解析，生成网页形式的说明文档,在IDEA软件中可以直接使用Tools中的Gerenate JavaDoc生成。文档注释格式如下图：

/**
多行注释：
 @version JDK 8,IDEA Community 2020.3.1
 @author:  Li
 @time: 2021/02/25  16:05
 @description: TODO
*/
public Class HelloWord {
	public static void main(String[] args){
	System.out.print("hello word!");
	}
}

二、阿里巴巴注释规约

1、类、类属性、类方法的注释必须使用文档注释。
2、所有抽象方法（包括接口中的方法）必须使用文档注释，除了返回值、参数、异常说明外还需指出该方法所做事情及实现功能。
3、所有类必须添加创建者和时间。
4、方法内部单行注释在被注释语句上方再起一行，方法内部多行注释，注意与代码对齐。
5、所有枚举类型字段必须有注释，并说明妹妹个数据项的用途。