前言
小编做项目时,需要在新建的方法和类上面添加注释,却不想复制粘贴其他方法已有的注释,于是便上网查找答案,果然找到了,下面做一下记录总结,方便日后的回顾。
三种注释方式
行注释、块注释、方法或类说明注释。自己对于第一种比较熟悉,经常使用,块注释不经常使用,第三种基本没有使用过,下面具体演示一下使用过程。
行注释
一、快捷键:Ctrl + /
使用Ctrl+ /, 添加行注释,再次使用,去掉行注释
二、演示代码
if (hallSites != null && hallSites.size() > 0) {
//行注释
//最大行号
int maxRow = 0;
//最大列数
int maxCol = 0;
块注释
一、快捷键:Ctrl +Shift+ /
使用Ctrl+Shift+ /, 添加块注释,再次使用,去掉块注释;
注意:如果已经写好代码块,使用块注释需要先选中要注释的块;
去除注释的时候,不需要全部选中这块代码,只用光标在注释内容上按Ctrl+Shift+/即可。
二、演示代码
/** 块注释 */
/** 接口返回结果ErrorDesc */
public static final String Result_Error_Desc_500 = "SYS_ERROR";
方法说明注释
一、快捷键
输入/** ,点击“Enter”,自动根据参数和返回值生成注释模板
二、演示代码
/**
*
*这是方法说明注释
*/
/**
* 提供(相对)精确的除法运算,当发生除不尽的情况时,精确到 小数点以后10位,以后的数字四舍五入。
*
* @param v1
* 被除数
* @param v2
* 除数
* @return 两个参数的商
*/
public static double div(double v1, double v2) {
return div(v1, v2, DEF_DIV_SCALE);
}
三、如何自定义设置方法和类注释
推荐一篇博客:在idea中为类和方法自动生成注释
小结
希望这篇博客,对您有所帮助!
感谢您的访问!