Java Code Template

设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。

文件(Files)注释标签:

/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author ${user}
* @date ${date}
* @version V1.0
*/

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

/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/

字段(Fields)注释标签:

/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/

构造函数(Constructor)标签:

/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/

方法(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} the ${bare_field_name} to set
*/

要实现上面的注释模板,这需要将下面的配置文件导入就可以了:

<?xml version="1.0" encoding="UTF-8"?>
<templates>
    <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">
    /**
    * @Description: ${todo}(用一句话描述该文件做什么)
    * @author ${user}
    * @date ${date}
    * @version V1.0
    */
    </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">
    /**
    * @Description: ${todo}(这里用一句话描述这个类的作用)
    * @author ${user}
    * @date ${date}
    *
    * ${tags}
    */
    </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">
    /**
    * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
    */
    </template>
    <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="false"
        context="methodcomment_context"
        deleted="false"
        description="Comment for non-overriding methods"
        enabled="true"
        id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
        name="methodcomment">
    /**
    * @Title: ${enclosing_method}
    * @Description: ${todo}(这里用一句话描述这个方法的作用)
    * @param ${tags}    参数
    * @return ${return_type}    返回类型
    * @throws
    */
    </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">
    /* (非 Javadoc)
    * <p>Title: ${enclosing_method}</p>
    * <p>Description: </p>
    * ${tags}
    * ${see_to_overridden}
    */
    </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="gettercomment_context"
        deleted="false"
        description="Comment for getter method"
        enabled="true"
        id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
        name="gettercomment">
    /**
    * @return ${bare_field_name}
    */
    </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>
 </templates>
时间: 2024-10-12 06:00:22

Java Code Template的相关文章

Eclipse Code Template 设置自动加注释

Eclipse Code Template 设置自动加注释 设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦.现就每一个元素逐一介绍: 文件(Files)注释标签: /**    * @Title: ${file_name}  * @Package ${package_name}  * @Description: ${todo}(用一句话描述该文件做什

Eclipse设置代码模板Code Template

团队协作最好是使用相同的代码模板 Code Template,打开 Window -> Preference -> Java -> Code Style -> Code Template,然后展开 Comments 节点下的 Types 进行编辑(一般需要编辑该 Java 类的代码模板). 编辑 Code Template 如下 /** * @Description: ${todo}(这里用一句话描述这个类的作用) * @author ${user} * @since JDK 1.

How to generate UML Diagrams from Java code in Eclipse

UML diagrams compliment inline documentation ( javadoc ) and allow to better explore / understand a design. Moreover, you can print and bring them to table to discuss a design.In this post, we will install and use the ObjectAid plugin for Eclipse to

【Android XML】Android XML 转 Java Code 系列

最近在公司做一个项目,需要把Android界面打包进jar包给客户使用.对绝大部分开发者来说,Android界面的布局以XML文件为主,并辅以少量Java代码进行动态调整.而打包进jar包的代码,意味着无法通过常规的getResources(),getString()等方法来快速的获取资源,因为这些资源都是在apk安装的时候初始化生成的.为了满足客户的需求,笔者开始在网上寻找各种解决方案.结果如下: 1.apk 主体包方案 实现方法:安装一个新的apk,新apk和主apk使用android:sh

HTMLPARSER JAVA CODE

1 /*** 2 * Licensed to the Apache Software Foundation (ASF) under one or more 3 * contributor license agreements. See the NOTICE file distributed with 4 * this work for additional information regarding copyright ownership. 5 * The ASF licenses this f

[转]Java Code Examples for android.util.JsonReader

[转]Java Code Examples for android.util.JsonReader The following are top voted examples for showing how to use android.util.JsonReader. These examples are extracted from open source projects. You can vote up the examples you like and your votes will b

SQL to Elasticsearch java code

把Elasticsearch当成Database用,因为Elasticsearch不支持SQL,就需要把SQL转换成代码实现. 1.按某个field group by查询count SELECT fieldA, COUNT(fieldA) from table WHERE fieldC = "hoge" AND fieldD = "huga" AND fieldB > 10 AND fieldB < 100 group by fieldA; 对应的jav

JUnit单元测试教程(翻译自Java Code Geeks)

JUnit单元测试教程--终极指南 JUnit单元测试教程终极指南 说明 单元测试简介 1 什么是单元测试 2 测试覆盖 3 Java中的单元测试 JUnit简介 1 使用Eclipse实现简单JUnit测试例子 使用Eclipse实现完整的JUnit例子 1 创建工程 2 创建要被测试的Java类 3 创建并运行JUnit测试用例 4 使用Ignore注解 5 创建测试套件suite tests 6 创建参数化测试parameterized tests 7 规则Rules 8 策略Catego

How to support both ipv4 and ipv6 address for JAVA code.

IPv6 have colon character, for example FF:00::EEIf concatenate URL String, IPv6 URL will like: http://FF:00::EE:8888/a/b/cActually we want: http://[FF:00::EE]:8888/a/b/cSimply concatenate URL will cause error. Take above line for example. If not use