JavaSE（一）注释和javadoc

单行注释

以“//”开头的注释
IDEA快捷键：CTRL+/（再次按可以撤销注释）
一般用来注释局部变量

//我是单行注释
//我也是单行注释

多行注释

以“/*”开头“*/”结束，中间添加内容的注释
IDEA快捷键：CTRL+SHIFT+/(再次按可以取消注释)
一般用来注释文件头、算法实现、方法中的复杂代码块、修改记录

/*
lalalala
我是多行注释
*/

多行注释内可以添加单行注释“//” 但不能嵌套多行注释“/* */ ”

如上 如果在多行注释内嵌套多行注释 第一个多行注释的“/*”会和第二个多行注释的“*/”匹配，导致第一个多行注释的“*/”不能被识别，变成非法语句

文档注释

以“/**”开始，以“*/”结束
IDEA快捷键：输入后/**+ENTER
一般用来注释说明性的文字和一些javadoc标签，可用来注释类、接口、静态方法、成员方法、静态变量、成员变量、常量

/**
 * 我是可爱的文档注释
 * @author oriko
 * @version 1.0
 * @date 2020/7/3 0:10
 */

javadoc

javadoc命令是用来生成自己API文档的
常用的javadoc标签：

标签	描述
@author	标识一个类的作者
@version	版本号
@since	API在什么程序的什么版本后开发支持
@param	说明一个方法的参数
@return	说明返回值类型
@throws	标志一个类抛出的异常