一、单行注释
说明:单行注释 一般注释少量的代码或者说明内容
格式://注释的内容
IDEA中的快捷键:使用Ctrl /, 添加行注释,再次使用,去掉行注释
二、多行注释
说明:多行注释 一般注释大量的代码或者说明内容
格式:/*注释的内容*/
IDEA中的快捷键:使用 Ctrl Shift /, 添加块注释,再次使用,去掉块注释;*/
三、文档注释
说明:文档注释 一般用于对类和方法进行功能说明
格式:/**注释的内容*/
IDEA中的快捷键:IDEA中文档注释快捷键 : 输入/**
,点击“Enter”,自动根据参数和返回值生成注释模板
1、类、接口上常用的标注
代码语言:javascript复制 /** 类、接口上常用的标注
* @author lizhengi #此部分代码开发者的信息、联系方式
* @version 1.0 #版本
* @see conf.DbConfig #另请参阅,链接到其它类|接口的文档
* @deprecated #不推荐使用
* */
2、方法上常用的标注
代码语言:javascript复制/** 方法上常用的标注
* @param username 用户名 #参数含义
* @return 成功返回1,失败返回0 #返回值说明
* @throws IOException #抛出的异常
* @exception IOException #也可以用此标记来说明抛出的异常
* @see conf.DbConfig #另请参阅,链接到其它类|接口的文档
* @deprecated #不推荐使用
*/