如何在Eclipse中如何自動添加注釋和自定義注釋風(fēng)格

設(shè)置注釋模板

設(shè)置注釋模板的入口：Window->Preference->Java->Code Style->Code Template ，然后展開Comments節(jié)點(diǎn)就是所有需設(shè)置注釋的元素了！ 這里寫圖片描述 接下來，對每一個(gè)元素逐一介紹：

• 文件(Files)注釋標(biāo)簽

Files標(biāo)簽是對新建的文件的說明，出現(xiàn)在文件最上面

舉栗子：

/**

• Copyright ? ${year} eSunny Info. Tech Ltd. All rights reserved.
• @Package: ${package_name}
• @author: ${user}
• @date: ${date} ${time} */

• 類型(Types)注釋標(biāo)簽（類的注釋）

Types標(biāo)簽是對類Class的一個(gè)說明，出現(xiàn)在類上面

舉栗子：

/**

• @ClassName: ${type_name}
• @Description: ${todo}
• @author: ${user}
• @date: ${date} ${time}
• ${tags} */

• 字段(Fields)注釋標(biāo)簽

Fields標(biāo)簽是對變量字段的說明

舉栗子：

// @Fields ${field} : ${todo}(用一句話描述這個(gè)變量表示什么)

• 構(gòu)造函數(shù)(Constructors)標(biāo)簽

Constructors標(biāo)簽是對類的構(gòu)造函數(shù)的說明

舉栗子：

/**

• @Title:${enclosing_type}
• @Description:${todo}
• ${tags} */

• 方法(Methods)標(biāo)簽

Methods標(biāo)簽是對函數(shù)方法的說明

舉栗子：

/**

• @Title: ${enclosing_method}
• @Description: ${todo}
• ${tags} ${return_type}
• @author ${user}
• @date ${date}${time} */

• 覆蓋方法(Overriding Methods)標(biāo)簽

Overriding Methods標(biāo)簽是對覆蓋方法的說明

舉栗子：

/* (non Javadoc)

• @Title: ${enclosing_method}
• @Description: ${todo}
• ${tags}
• ${see_to_overridden} */

• 代表方法(Delegate Methods)標(biāo)簽

舉栗子：

/**

• ${tags}
• ${see_to_target} */

• getter方法標(biāo)簽

舉栗子：

/**

• @return ${bare_field_name}
  */

• setter方法標(biāo)簽

舉栗子：

/**

• @param ${param} 要設(shè)置的 ${bare_field_name}
  */

以上標(biāo)簽，只需要點(diǎn)擊右側(cè)面板上的按鈕 – 編輯(Edit)， 便可修改成自己的注釋！ 如何自動添加注釋

可通過如下三種方法自動添加注釋：

（1）輸入“/**”并回車。 （2）用快捷鍵 Alt＋Shift+J（先選中某個(gè)方法、類名或變量名）。 （3）在右鍵菜單中選擇“Source > Generate ElementComment”。

另外，新建文件或類的時(shí)候，怎么自動生成文件(file)的注釋呢？

只需要勾選Automatically and comments for new methods and types即可！

導(dǎo)入/導(dǎo)出代碼格式模板

如果你辛辛苦苦定制好了自己的代碼風(fēng)格，然后換了臺機(jī)器進(jìn)行操作或重裝了Eclipse，是不是要重新配置一遍呢？答案當(dāng)然是No了，Eclipse提供了“導(dǎo)出”和“導(dǎo)入”功能，你可以把自己的模板導(dǎo)出來在其他機(jī)器上使用。

創(chuàng)建自定義注釋模板

eclipse自帶一些注釋模板，如日期(@date)、文件名(@ClassName)、作者(@author)等，那么怎么自定義一些注釋模板呢？

轉(zhuǎn)載地址：https://blog.csdn.net/changqing5818/article/details/51996302