zoukankan      html  css  js  c++  java
  • 使用MyEclipse生成Java注释时,使用的Code Template

    设置注释模板的入口: Window->Preference->Java->Code Style->Code Template,

    然后展开Comments节点就是所有需设置注释的元素。

    以下是部分示例,同时文章最后有两种Code Template可供大家参考使用。


    文件(Files)注释标签:

    /**
     * @projectName SpringMVC
     * @package com.candy.candy.test.CodeStyleTemplate.java
     * @Copyright Copyright(c) 2014 Candy工会
     * @author Candy czx
     * @date 2014-10-24 上午12:06:02
     * @version V1.0
     */
    package com.candy.candy.test;

    类型(Types)注释标签(类的注释):

    /**
     * TODO
     * @author Candy czx
     * @date 2014-10-24 上午12:06:02
     * @version V1.0
     */
    public class CodeStyleTemplate {}

    方法(Constructor & Methods)标签:

        /**
         * TODO
         * @author Candy czx
         * @date 2014-10-24 上午12:07:06
         * @version V1.0
         * @param arg1
         * @param arg2
         * @return
         */
        public String testCodeStyleTemplate(String arg1, String arg2) {
            return null;
        }

    其他方法、属性等标签的Code Style的模板按照默认值进行配置。


    附1:以上配置的codetemplates.xml,直接进行复制粘贴即可。

    <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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="true" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
     * 
     */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
     * ${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="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="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
     * ${todo}
     * @author Candy czx
     * @date ${date} ${time}
     * @version V1.0
     * ${tags}
     */</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">/**
     * ${tags}
     * ${todo}
     * @author Candy czx
     * @date ${date} ${time}
     * @version V1.0
     */</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">/**
     * @projectName ${project_name}
     * @package ${package_name}.${file_name}
     * @Copyright Copyright(c) ${year} Candy工会
     * @author Candy czx
     * @date ${date} ${time}
     * @version V1.0
     */</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
     * @return the ${bare_field_name}
     */</template></templates>

    附2:在公司使用的codetemplates.xml,直接进行复制粘贴即可。

    <?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><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="true" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
     * @return the ${bare_field_name}
     */</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">/**
     * @Package ${package_name}
     * @Description ${todo}
     * @author ${user}
     * @date ${date}
     * ${tags}
     */</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"/><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="true" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
     * 
     */</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
     * ${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 ${user}
     * @date ${date}
     * ${tags}
     */</template></templates>
  • 相关阅读:
    从零实现一个http服务器
    服务器端编程心得(七)——开源一款即时通讯软件的源码
    服务器端编程心得(六)—— 关于网络编程的一些实用技巧和细节
    服务器编程心得(五)—— 如何编写高性能日志
    以芯片直读方式得到的Android全盘镜像解析——DOS分区
    一款开源数据恢复工具——scalpel
    以芯片直读方式得到的全盘镜像解析及ext4日志区域解析——GPT分区
    Linux程序设计之shell程序设计
    算法——蛮力法之最近对问题和凸包问题
    算法——蛮力法之顺序查找和蛮力字符串匹配
  • 原文地址:https://www.cnblogs.com/Candies/p/4047230.html
Copyright © 2011-2022 走看看