IDE-Ecplise-代碼註釋 模版 編碼規範 配色

說明： 代碼註釋主要用於方便代碼後期維護，編碼規範，增長代碼閱讀性和維護性。因網上看到的不少博客中片斷局多，故整理後重寫一篇，方便交流學習。

　

• 　　先看下加過註釋模版後的效果。

如上圖所示，建立類，方法和繼承方法後 的效果。

配色圖以下所示

• 先看下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