前言
小編做項目時,需要在新建的方法和類上面添加註釋,卻不想複製粘貼其他方法已有的註釋,於是便上網查找答案,果然找到了,下面做一下記錄總結,方便日後的回顧。
三種註釋方式
行註釋、塊註釋、方法或類說明註釋。自己對於第一種比較熟悉,經常使用,塊註釋不經常使用,第三種基本沒有使用過,下面具體演示一下使用過程。
行註釋
一、快捷鍵: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中爲類和方法自動生成註釋
小結
希望這篇博客,對您有所幫助!
感謝您的訪問!