說(shuō)明： 代碼注釋主要用于方便代碼后期維護(hù)，編碼規(guī)范，增加代碼閱讀性和維護(hù)性。因網(wǎng)上看到的很多博客中片段局多，故整理后重寫一篇，方便交流學(xué)習(xí)。

　

• 　　先看下加過(guò)注釋模版后的效果。

如上圖所示，創(chuàng)建類，方法和繼承方法后 的效果。

配色圖如下所示

• 先看下ecplise中模版設(shè)置的位置

?依次打開 Preferences －》Java選項(xiàng) －》Code Style －》Code Templates－》Comments?

look 如上圖所示 ： comments 節(jié)點(diǎn)下對(duì)應(yīng)的節(jié)點(diǎn)就是創(chuàng)建文件，類，方法的注釋模版的位置了

• 關(guān)于每個(gè)節(jié)點(diǎn)下的注釋寫法

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

/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句話描述該文件做什么) * @author <作者姓名> * @date ${date}${time}

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

/** * @ClassName: ${type_name} * @Description: ${todo}(這里用一句話描述這個(gè)類的作用) * @author <作者姓名>* @date ${date} ${time} * ${tags} */

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

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

?

Constructor?標(biāo)簽：

/** * * ${tags} */

?

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

/** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個(gè)方法的作用) * @param ${tags} 設(shè)定文件 * @return ${return_type} 返回類型 * @throws */

?

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

/* *<非doc 標(biāo)簽> * Title: ${enclosing_method} * Description: ${todo} 父類方法描述 * ${tags} * ${see_to_overridden} */

?

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

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

?

Getter方法標(biāo)簽：

/*** @return the ${bare_field_name}*/

?

Setter方法標(biāo)簽：

/*** @param ${param} the ${bare_field_name} to set*/

?

• 最后一點(diǎn)小細(xì)節(jié) 如果你想要?jiǎng)?chuàng)建類的時(shí)候就自動(dòng)有注釋 請(qǐng)看下圖

　　　

• 關(guān)于doc文檔常用注釋元素的含義 <引用>，想了解更多可搜索 ?　"javadoc標(biāo)記" 即可

?

?

• 標(biāo)簽中函數(shù)寫法見提示即可

　

• 最后簡(jiǎn)單說(shuō)下配色方案

　　可以到如下網(wǎng)址去下載配置文件然后倒入到ecplise中

　　http://eclipsecolorthemes.org/?list=toppicks&lang=java

? ? ? ?或者在ecplise中 Help->install new soft->add ? 添加如下網(wǎng)址??http://eclipse-color-theme.github.com/update 進(jìn)行更新

更新后 在Preferences->General->color theme中就可以找到相應(yīng)的模版方案了

?

• ? 結(jié)篇 ?附上模版文檔，如有遺漏歡迎指證

鏈接: http://pan.baidu.com/s/1jG8Lj8q 密碼: zh7f

?

轉(zhuǎn)載于:https://www.cnblogs.com/Joker_/p/4809927.html

總結(jié)

以上是生活随笔為你收集整理的IDE-Ecplise-代码注释 模版 编码规范 配色的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。