如何為eclipse程式碼添加註釋模版,註釋快捷鍵?
/**
* Copyright © ${year}Company. All rightsreserved.
*
* @Title: ${file_name}
* @Prject: ${project_name}
* @Package: ${package_name}
* @Description: ${todo}
* @author: ${user}
* @date: ${date} ${time}
* @version: V1.0
*/
型別(Types)註釋標籤(類的註釋):
/**
* @ClassName: ${type_name}
* @Description
* @author: ${user}
* @date: ${date} ${time}
* ${tags}
*/
欄位(Fields)註釋標籤:
/**
* @fieldName: ${field}
* @fieldType: ${field_type}
* @Description: ${todo}
*/
建構函式標籤:
/**
* @Title:${enclosing_type}
* @Description:${todo}
* ${tags}
*/
方法(Constructor& Methods)標籤:
/**
* @Title: ${enclosing_method}
* @Description: ${todo}
* ${tags}
* @return: ${return_type}
*/
覆蓋方法(OverridingMethods)標籤:
/* (non Javadoc)
* @Title: ${enclosing_method}
* @Description: ${todo}
* ${tags}
* ${see_to_overridden}
*/
代表方法(DelegateMethods)標籤:
/**
* ${tags}
* ${see_to_target}
*/
getter方法標籤:
/**
* @return the ${bare_field_name}
*/
setter方法標籤:
/**
* @param ${param} the ${bare_field_name} toset
*/
或者可以從網上下載配置好的.xml檔案匯入也可以。下載請點選我!
PS:在按照上面的方法設定後,一定要到windows->Preferences->general->ContentTypes,右側Context Types樹,點開Text,選擇Java Source File,在下面的Default encoding輸入框中輸入UTF-8,點Update,則設定Java檔案編碼為UTF-8,否則會出現字元編碼的問題。
經過如上的設定後,就可以使用快捷鍵Alt+Shift+J來快速生成文件的註釋了。使用方法如下:
檔案頭註釋:
使用New->Class方法生成的檔案會在建立類的對話方塊選項中提示是否生成註釋,預設是選中的。這樣生成的.java檔案就有在檔案頭帶有上面設定的版權資訊。若是使用New->File方法建立的java檔案則不會自動生成檔案頭的版權資訊,必須手動輸入。
方法、類、欄位等註釋:
這一類的註釋只需要選中方法名、類名、或欄位名(前提條件!!!),然後使用Alt+Shift+J來自動生成註釋,然後補全資訊即可。