Eclipse Code Template 設置自動加註釋

設置註釋模板的入口: Window->Preference->Java->Code Style->Code Template 而後展開Comments節點就是全部需設置註釋的元素啦。現就每個元素逐一介紹:windows

文件(Files)註釋標籤:eclipse

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句話描述該文件作什麼) 
* @author A18ccms A18ccms_gmail_com   
* @date ${date} ${time} 
* @version V1.0   
*/ide

類型(Types)註釋標籤(類的註釋):函數

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

* ${tags} 
*/ui

字段(Fields)註釋標籤:編碼

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

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

方法(Constructor & Methods)標籤:xml

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

覆蓋方法(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="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: wanghui-hd2007@163.com
     * @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: wanghui-hd2007@163.com

     * @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: wanghui-hd2007@163.com

     * @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: wanghui-hd2007@163.com

     * @version: ${date} ${time} 
     */ 
    </template> 
</templates>

MyEclipse 6.5 代碼提示的設置

MyEclipse 選擇 Windows ->Preperences ->General ->keys

找到 word completion的快捷鍵 把原alt+/刪掉!//必須

把Content Assist 的快捷鍵 改爲alt+/ 或者你想改的其餘快捷鍵

MyEclipse編碼設置

Myeclipse安裝後編碼默認是GB18030,通常推薦用UTF-8。若是在導入項目後發現亂碼現象,那是編碼設置設置不對。

全局編碼設置的方法:ToolBar-->Window-->Preferences-->General-->Workspace-->Text file encoding,設置合適的編碼。

局部編碼設置:在源碼按右鍵-->General-->Editors-->Test Editors-->Spelling-->Encoding,這裏是設置單個文件的編碼。

推薦仍是使用全局編碼設置。

MyEclipse設置JSP頁面默認編碼方式:

windows(窗口)-Preferences(首選項)-MyEclipse-Files & Editors-JSP-右側encoding:設置爲ISO10646/Unicode(UTF-8)

MyEclipse在Java文件中設置做者、日期等說明:

windows(窗口)-Preferences(首選項)-Java-Code Style(代碼樣式)-Code Templates(代碼模版)-右側Comments(註釋)-選擇Types(類型)-點擊edit(編輯)-輸入以下信息

/**
* @包名   ${package_name}
* @文件名 ${file_name}
* @做者   汪輝
* @建立日期 ${date}
* @版本 V 1.0
*/

點擊OK(肯定)-選中左側的代碼樣式-選擇右側複選框(Automatically add Comments for new Methods and types)(自動爲新方法和類型添加註釋)-點擊Apply(應用)-點擊OK(肯定)

相關文章
相關標籤/搜索