2. 程式人生 > >Eclipse Java註釋模板設定詳解 快捷鍵：Shift+Alt+J

Eclipse Java註釋模板設定詳解 快捷鍵：Shift+Alt+J

阿新 • • 發佈：2019-02-14

設定註釋模板的入口： Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素啦。現就每一個元素逐一介紹：


檔案(Files)註釋標籤：


/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句話描述該檔案做什麼) 
* @author A18ccms A18ccms_gmail_com   
* @date ${date} ${time} 
* @version V1.0   
*/
型別(Types)註釋標籤（類的註釋）：


/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(這裡用一句話描述這個類的作用) 
* @author A18ccms a18ccms_gmail_com 
* @date ${date} ${time} 
* 
* ${tags} 
*/


欄位(Fields)註釋標籤：


/** 
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼) 
*/ 
建構函式標籤：


/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/


方法(Constructor & Methods)標籤：


/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(這裡用一句話描述這個方法的作用) 
* @param ${tags}    設定檔案 
* @return ${return_type}    返回型別 
* @throws 
*/


覆蓋方法(Overriding Methods)標籤：


/* (非 Javadoc) 
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/


代表方法(Delegate Methods)標籤：


/** 
* ${tags} 
* ${see_to_target} 
*/ 
getter方法標籤：


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


setter方法標籤：


/** 
* @param ${param} 要設定的 ${bare_field_name} 
*/


簡單模板例子： 
<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="欄位的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**  
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)  
*/  
</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**  
* @return ${bare_field_name}  
*/  
</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="建立的建構函式的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**  
* <p>Title:${file_name} </p>  
* <p>Description: 建構函式</p>  
* ${tags}  
*/  
</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已建立的 Java 檔案的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**    
* @Title: ${file_name}  
* @Package ${package_name}  
* @Description: ${todo}(用一句話描述該檔案做什麼)  
* @author DAIGUANGJIU     
* @date ${date} ${time}  
* @version V1.0    
*/  
</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**  
* @param ${param} 要設定的 ${bare_field_name}  
*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="建立的型別的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**  
* @author ${user}  
*  
* ${tags}  
*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**  
* ${tags}  
* ${see_to_target}  
*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc)  
* <p>Title: ${enclosing_method}</p>  
* <p>Description: </p>  
* ${tags}  
* ${see_to_overridden}  
*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**  
* ${tags}  
*/</template></templa  
<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="欄位的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/** 
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼) 
*/ 
</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** 
* @return ${bare_field_name} 
*/ 
</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="建立的建構函式的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** 
* <p>Title:${file_name} </p> 
* <p>Description: 建構函式</p> 
* ${tags} 
*/ 
</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已建立的 Java 檔案的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**  
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句話描述該檔案做什麼) 
* @author DAIGUANGJIU   
* @date ${date} ${time} 
* @version V1.0  
*/ 
</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** 
* @param ${param} 要設定的 ${bare_field_name} 
*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="建立的型別的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** 
* @author ${user} 
* 
* ${tags} 
*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** 
* ${tags} 
* ${see_to_target} 
*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc) 
* <p>Title: ${enclosing_method}</p> 
* <p>Description: </p> 
* ${tags} 
* ${see_to_overridden} 
*/</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** 
* ${tags} 
*/</template></templa


例子2： 
<?xml version="1.0" encoding="UTF-8"?>  
<templates>  
    <template    
                autoinsert="false"    
                context="constructorcomment_context"    
                deleted="false"    
                description="Comment for created constructors"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"  
                name="constructorcomment">  
    /**   
     * 建立一個新的例項 ${enclosing_type}.   
     *   
     * ${tags}   
     */   
    </template>  
    <template    
                autoinsert="true"    
                context="settercomment_context"  
                deleted="false"    
                description="Comment for setter method"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.settercomment"    
                name="settercomment">  
    /**   
     * @param ${param} the ${bare_field_name} to set   
     */   
    </template>  
    <template  
                autoinsert="false"    
                context="methodcomment_context"    
                deleted="false"    
                description="Comment for non-overriding methods"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"    
                name="methodcomment">  
    /**   
     * 此方法描述的是：   
     * @author:
[email protected]   
     * @version: ${date} ${time}   
     */   
    </template>  
    <template    
                autoinsert="true"    
                context="delegatecomment_context"    
                deleted="false"    
                description="Comment for delegate methods"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"    
                name="delegatecomment">  
    /**   
     * ${tags}   
     * ${see_to_target}   
     */   
    </template>  
    <template  
                autoinsert="false"    
                context="filecomment_context"    
                deleted="false"    
                description="Comment for created Java files"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"    
                name="filecomment">  
    /**   
     * 檔名：${file_name}   
     *   
     * 版本資訊：   
     * 日期：${date}   
     * Copyright 足下 Corporation ${year}    
     * 版權所有   
     *   
     */   
    </template>  
    <template    
                autoinsert="false"    
                context="gettercomment_context"    
                deleted="false"    
                description="Comment for getter method"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"    
                name="gettercomment">  
    /**   
     * ${bare_field_name}   
     *   
     * @return  the ${bare_field_name}   
     * @since   CodingExample Ver(編碼範例檢視) 1.0   
    */   
    </template>  
    <template    
                autoinsert="true"    
                context="overridecomment_context"    
                deleted="false"    
                description="Comment for overriding methods"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"    
                name="overridecomment">  
    /* (non-Javadoc)   
     * ${see_to_overridden}   
     */   
    </template>  
    <template    
                autoinsert="false"    
                context="fieldcomment_context"    
                deleted="false"    
                description="Comment for fields"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"    
                name="fieldcomment">  
    /**   
     * ${field}:${todo}（用一句話描述這個變量表示什麼）   
     *   
     * @since Ver 1.1   
     */   
    </template>  
    <template    
                autoinsert="false"    
                context="typecomment_context"    
                deleted="false"    
                description="Comment for created types"    
                enabled="true"    
                id="org.eclipse.jdt.ui.text.codetemplates.typecomment"    
                name="typecomment">  
    /**   
     * 此類描述的是：   
     * @author:
[email protected]   
     * @version: ${date} ${time}    
     */   
    </template>  
</templates>  
<?xml version="1.0" encoding="UTF-8"?> 
<templates> 
    <template 
                autoinsert="false" 
                  context="constructorcomment_context" 
                deleted="false" 
                description="Comment for created constructors" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" 
                name="constructorcomment"> 
    /** 
     * 建立一個新的例項 ${enclosing_type}. 
     * 
     * ${tags} 
     */ 
    </template> 
    <template 
                autoinsert="true" 
                context="settercomment_context" 
                deleted="false" 
                description="Comment for setter method" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.settercomment" 
                name="settercomment"> 
    /** 
     * @param ${param} the ${bare_field_name} to set 
     */ 
    </template> 
    <template 
                autoinsert="false" 
                context="methodcomment_context" 
                deleted="false" 
                description="Comment for non-overriding methods" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" 
                name="methodcomment"> 
    /** 
     * 此方法描述的是： 
     * @author:
[email protected] 
     * @version: ${date} ${time} 
     */ 
    </template> 
    <template 
                autoinsert="true" 
                context="delegatecomment_context" 
                deleted="false" 
                description="Comment for delegate methods" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" 
                name="delegatecomment"> 
    /** 
     * ${tags} 
     * ${see_to_target} 
     */ 
    </template> 
    <template 
                autoinsert="false" 
                context="filecomment_context" 
                deleted="false" 
                description="Comment for created Java files" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment" 
                name="filecomment"> 
    /** 
     * 檔名：${file_name} 
     * 
     * 版本資訊： 
     * 日期：${date} 
     * Copyright 足下 Corporation ${year} 
     * 版權所有 
     * 
     */ 
    </template> 
    <template 
                autoinsert="false" 
                context="gettercomment_context" 
                deleted="false" 
                description="Comment for getter method" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" 
                name="gettercomment"> 
    /** 
     * ${bare_field_name} 
     * 
     * @return  the ${bare_field_name} 
     * @since   CodingExample Ver(編碼範例檢視) 1.0 
    */ 
    </template>


    <template 
                autoinsert="true" 
                context="overridecomment_context" 
                deleted="false" 
                description="Comment for overriding methods" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" 
                name="overridecomment"> 
    /* (non-Javadoc) 
     * ${see_to_overridden} 
     */ 
    </template> 
    <template 
                autoinsert="false" 
                context="fieldcomment_context" 
                deleted="false" 
                description="Comment for fields" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" 
                name="fieldcomment"> 
    /** 
     * ${field}:${todo}（用一句話描述這個變量表示什麼） 
     * 
     * @since Ver 1.1 
     */ 
    </template> 
    <template 
                autoinsert="false" 
                context="typecomment_context" 
                deleted="false" 
                description="Comment for created types" 
                enabled="true" 
                id="org.eclipse.jdt.ui.text.codetemplates.typecomment" 
                name="typecomment"> 
    /** 
     * 此類描述的是： 
     * @author: [email protected] 
     * @version: ${date} ${time} 
     */ 
    </template> 
</templates>


本文來自CSDN部落格，轉載請標明出處：http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx

相關推薦

Eclipse Java註釋模板設定詳解 快捷鍵：Shift+Alt+J

設定註釋模板的入口： Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素啦。現就每一個元素逐一介紹： 檔案(Files)註釋標籤： /**  

Eclipse Java註釋模板設定詳解

出於對作者的尊重和感謝，原文地址為http://blog.csdn.net/ahhsxy/article/details/4542682 設定註釋模板的入口： Window->Preference->Java->Code Style->Co

Eclipse註釋模板設定詳解

設定註釋模板的入口：Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素。本文現就每一個元素逐一給大家介紹一下。 檔案(Files)註釋標籤： 1

Android Studio "佛祖保佑 永無bug" 註釋模板設定詳解(僅供娛樂)

1、註釋模板效果圖 今天在網上看到一段有趣的註釋，佛祖保佑 永無bug， 效果如下圖所示： 程式碼如下所示： /** * _ooOoo_ *

Eclipse Java註釋和程式碼模板設定詳解

參考：http://www.cnblogs.com/senzjx/archive/2009/09/21/1570950.html 1、設定註釋模板的入口： Window->Preference->Java->Code Style->Code Temp

Eclipse Java註釋模板設置詳解

comment ons gmail const mail pack led dcom time 設置註釋模板的入口： Window->Preference->Java->Code Style->Code Template 然後展開Comments節點

Java定時器的cron設定詳解Quartz

這些星號由左到右按順序代表 ： * * * * * * * 格式: [秒] [分] [小時] [日] [月] [周] [年] 序號 說明   是否必填  允許填寫的值         允許的萬用字元 1      秒          是        0-59      

Java虛擬機器（JVM）中的記憶體設定詳解

在一些規模稍大的應用中，Java虛擬機器（JVM）的記憶體設定尤為重要，想在專案中取得好的效率，GC（垃圾回收）的設定是第一步。 PermGen space：全稱是Permanent Generation space.就是說是永久儲存的區域,用於存放Class和Meta資

java Io 流類詳解

修改 文件目錄 != exe [] 深入 clas one fileinput 關於java 流類的復習；習慣性的復習按照圖結構一層層往下深入去了解去復習，最後通過代碼來實現感覺印象會更深刻一些； 關於 I/O流：IO可以理解為JAVA用來傳遞數據的管道

java Pattern和Matcher詳解

而且 建議 exc regex 示例 aabb 工廠 sta 數字 結論：Pattern與Matcher一起合作.Matcher類提供了對正則表達式的分組支持,以及對正則表達式的多次匹配支持. 單獨用Pattern只能使用Pattern.matcher(String reg

Java 多線程詳解（三）------線程的同步

alt 來看 監聽 介紹 創建進程 java 多線程 system ima 關鍵字 Java 多線程詳解（一）------概念的引入：http://www.cnblogs.com/ysocean/p/6882988.html Java 多線程詳解（二）------如何創建進

Java反射機制深入詳解

const 運行時 設計 應用程序 類加載器 分配 import 程序 為什麽 一.概念 　　反射就是把Java的各種成分映射成相應的Java類。 　　Class類的構造方法是private，由JVM創建。 　　反射是java語言的一個特性，它允程序在運行時（註意不是編譯的

10.5-全棧Java筆記:常見流詳解（三）

java上節我們講到「Java中常用流：緩沖流」，本節我們學習數據流和對象流~ 數據流數據流將“基本數據類型變量”作為數據源，從而允許程序以與機器無關方式從底層輸入輸出流中操作java基本數據類型。 DataInputStream和DataOutputStream提供了可以存取與機器無關的所有Java基礎類

POJ 3164 Command Network（最小樹形圖模板題+詳解）

noop clu html 建立 eof std const temp pri http://poj.org/problem?id=3164 題意： 求最小樹形圖。 思路： 套模板。 引用一下來自大神博客的講解：http://www.cnblogs.co

java字符串詳解

字符串 [] min 詳解 pro java true 常量 intern class StringEqualTest { public static void main(String[] args) { String s1 = "Programming";

Java的反射機制詳解（一）

pbc spa 詳解 uno face target lan tor cin 8n72q傅釁8戰sig叢http://www.docin.com/app/user/userinfo?userid=179185461 8u炊3F7LB椒1http://huiyi.docin.

Java線程池詳解

最大 rar exception subject alt mod allow 隨著 double 一、線程池初探 所謂線程池，就是將多個線程放在一個池子裏面（所謂池化技術），然後需要線程的時候不是創建一個線程，而是從線程池裏面獲取一個可用的線程，然後執行我們的任務。線程池

Java中反射機制詳解

turn face instance java struct () 分享 2.6 一個 　　　　序言 　　　　　　在學習java基礎時，由於學的不紮實，講的實用性不強，就覺得沒用，很多重要的知識就那樣一筆帶過了，像這個馬上要講的反射機制一樣，當時學的時候就忽略了，到後來學習

Java Web(一) Servlet詳解！！

註意 ont 道理 resource 通過 long values arr 客戶端請求 　　　　這篇文章到上一篇，距離的有點遙遠呀，隔了大概有兩個月把，中間在家過了個年，哈哈~ 現在重新開始拾起，最近在看一本個人覺得很棒的書，《Java Web 整合開發王者歸來》，現在寫的

Java中的ant詳解

問題 noi mar gin otf left 源代碼 都是 tps 分享一套幾十個源代碼，都是vc++的，打包提供 包含指針的結構數組，初始化問題 《！———— C++ 中 export 關鍵字的尷尬處境 ————》 想做一個小東西不知從何入手 493YR誒詰B駝