在Eclipse中生成函數說明注釋(JavaDoc風格)可以通過以下方法實現:
- 快捷鍵方式:
- 將光標放在函數上方
- 輸入
/**
后按回車鍵 - Eclipse會自動生成包含參數和返回值的注釋模板
- 菜單方式:
- 選中函數
- 點擊菜單欄 Source > Generate Element Comment
快捷鍵生成注釋?:將光標放在方法名上,按下快捷鍵Alt+Shift+J
,Eclipse會自動生成方法注釋的框架,例如:
/**
?* @param str
?* @return
?* @throws ParseException
?*/
- 自定義模板:
可通過Window > Preferences > Java > Code Style > Code Templates進行自定義
示例生成的注釋格式:
/**
?* 計算兩個數的和
?* @param a 第一個加數
?* @param b 第二個加數
?* @return 兩個參數的和
?*/
public int add(int a, int b) {
??? return a + b;
}
如需配置團隊統一的注釋規范,建議在項目設置中共享code template配置文件。