說明: 代碼注釋主要用于方便代碼后期維護,編碼規范,增加代碼閱讀性和維護性。因網上看到的很多博客中片段局多,故整理后重寫一篇,方便交流學習。
- 先看下加過注釋模版后的效果。
如上圖所示,創建類,方法和繼承方法后 的效果。
配色圖如下所示
- 先看下ecplise中模版設置的位置
?依次打開 Preferences -》Java選項 -》Code Style -》Code Templates-》Comments?
look 如上圖所示 : comments 節點下對應的節點就是創建文件,類,方法的注釋模版的位置了
- 關于每個節點下的注釋寫法
文件(Files)注釋標簽:
/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句話描述該文件做什么) * @author <作者姓名> * @date ${date}${time}
類型(Types)注釋標簽(類的注釋):
/** * @ClassName: ${type_name} * @Description: ${todo}(這里用一句話描述這個類的作用) * @author <作者姓名>* @date ${date} ${time} * ${tags} */
字段(Fields)注釋標簽:
/*** @Fields ${field} : ${todo}(用一句話描述這個變量表示什么)*/
?
Constructor?標簽:
/** * * ${tags} */
?
方法(Methods)標簽:
/** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個方法的作用) * @param ${tags} 設定文件 * @return ${return_type} 返回類型 * @throws */
?
覆蓋方法(Overriding Methods)標簽:
/* *<非doc 標簽> * Title: ${enclosing_method} * Description: ${todo} 父類方法描述 * ${tags} * ${see_to_overridden} */
?
代表方法(Delegate Methods)標簽:
/*** ${tags}* ${see_to_target}*/
?
Getter方法標簽:
/*** @return the ${bare_field_name}*/
?
Setter方法標簽:
/*** @param ${param} the ${bare_field_name} to set*/
?
- 最后一點小細節 如果你想要創建類的時候就自動有注釋 請看下圖
- 關于doc文檔常用注釋元素的含義 <引用>,想了解更多可搜索 ? "javadoc標記" 即可
?
?
- 標簽中函數寫法見提示即可
- 最后簡單說下配色方案
可以到如下網址去下載配置文件然后倒入到ecplise中
http://eclipsecolorthemes.org/?list=toppicks&lang=java
? ? ? ?或者在ecplise中 Help->install new soft->add ? 添加如下網址??http://eclipse-color-theme.github.com/update 進行更新
更新后 在Preferences->General->color theme中就可以找到相應的模版方案了
?
- ? 結篇 ?附上模版文檔,如有遺漏歡迎指證
鏈接: http://pan.baidu.com/s/1jG8Lj8q 密碼: zh7f
?