zoukankan      html  css  js  c++  java
  • Eclipse Code Template 设置自动加注释

    设置注释模板的入口: 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="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(确定)

    做几年有理想的人
  • 相关阅读:
    UVA 11488 Hyper Prefix Sets (字典树)
    UVALive 3295 Counting Triangles
    POJ 2752 Seek the Name, Seek the Fame (KMP)
    UVA 11584 Partitioning by Palindromes (字符串区间dp)
    UVA 11100 The Trip, 2007 (贪心)
    JXNU暑期选拔赛
    计蒜客---N的-2进制表示
    计蒜客---线段的总长
    计蒜客---最大质因数
    JustOj 2009: P1016 (dp)
  • 原文地址:https://www.cnblogs.com/wanghuilt/p/3007060.html
Copyright © 2011-2022 走看看