Eclipse Code Template 设置自动加注释(转)

时间:2023-01-16 11:23:40

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 
*/

Eclipse Code Template 设置自动加注释(转)的更多相关文章

  1. &lpar;转&rpar;编码规范系列(一):Eclipse Code Templates设置

    背景:长久以来,对java编程中的注释不甚理解.再次学习<疯狂JAVA讲义>基础,深深的感到自己基本功的不牢固.所以要做到事无巨细,好好修炼. 认识注释 常识 注释的作用: 回顾原有的代码 ...

  2. eclipse svn插件 设置自动加锁相关

    eclipse svn插件 设置自动加锁相关 Subclipse 1.10.9 发布,改进说明:SVNKit 1.8.8Exception proof repository sorter. (1616 ...

  3. Eclipse&colon;设置自动生成注释

    一.设置自动生成 1.修改设置: 点击Window下的Preferences: 进入Java->Code Style->Code Templates的页面,选择Code下的New Java ...

  4. 编码规范系列(一):Eclipse Code Templates设置

    从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效 ...

  5. Eclipse Code Templates设置

    从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.俗话说约定优于配置,但是在执行过程中往往发现效 ...

  6. 编码规范:Eclipse Code Templates设置

    现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范.设置Code Templates的目的主要是为了统一各种注释的格式以及代码的模板 ...

  7. Eclipse下SpringBoot没有自动加载application&period;properties文件

    Eclipse内创建SpringBoot项目,在java/main/resources文件夹下面创建application.properties配置文件,SpringApplication.run后发 ...

  8. autocad2008&plus;C&num;2008开发中设置自动加载dll

    一.复制编译后的dlll路径,比如我的是D:\zjy\cad开发\学习\宗地图\bin\Debug\zd.dll 二.随便找个地方新建一个记事本,在记事本中写入以下内容: (command &quot ...

  9. 关于eclipse的编码注释等Code Template设置

    啥也不说直接放东西: 首先进入eclipse的preferences里的java 点击Insert variable可以自己设置需要的 1. 设置Files:点击edit, /** * <p&g ...

随机推荐

  1. &period;Net中Remoting通信机制

    Remoting通信机制 Remoting介绍 主要元素 通道类型 激活方式 对象定义 Remoting介绍 什么是Remoting,简而言之,我们可以将其看作是一种分布式处理方式. 从微软的产品角度 ...

  2. 怎么创建MongoDB数据库

    MongoDB didn’t provides any command to create “database“. Actually, you don’t need to create it manu ...

  3. 如何解决ORA-12547&colon; TNS&colon;lost contact错

    执行环境:ubuntu+oracle 11.2.0 为了启动oracle时间,出现ORA-12547: TNS:lost contact错误. 中午好好的纳,下午就无论了.以为是链接失效,关机重新启动 ...

  4. Alyona and a tree

    Alyona and a tree time limit per test 2 seconds memory limit per test 256 megabytes input standard i ...

  5. 菜鸟装逼指南--linux内核中听过就能记住的概念

    打算给我们部门弄个内部分享.发现大家对一些底层知识的认知停留在一句一句的,比如听说JVM使用-XX:-UseBiasedLocking取消偏向锁可以提高性能,因为它只适用于非多线程高并发应用.使用数字 ...

  6. git(一)快速入门

    1.设置用户名 git config --global user.name '你的用户名' ​ 2.设置用户名邮箱 git config --global user.email '你的邮箱' ​ 3. ...

  7. aps&period;net core mvc中使用session

    原因>>用session是想验证 前端输入的验证码和后端存入seesion的是否一致,也可以使用的是TempData[]. 铺垫>> 前端用GetValidateCode()方 ...

  8. ionic3&period;x版本-实现点击tab导航栏判断是否已经登陆然后加载不同页面,和退出登录功能。

    html代码: <ion-tabs #myTabs> <ion-tab [root]="tab1Root" tabTitle="首页" tab ...

  9. 学习DDD之路--勇于纠正自己的错误

    写这篇文章主要是之前三篇对DDD的介绍算是自己学习的一次试水,也希望能够有更多的人能帮我发现其中的问题.昨天继续阅读了DDD书,发现了自己之前的例子存在了一些问题,早上也和园友进行了一些讨论.最后整理 ...

  10. 【转载】Vue项目自动转换 px 为 rem,高保真还原设计图

    前端开发中还原设计图的重要性毋庸置疑,目前来说应用最多的应该也还是使用rem.然而很多人依然还是处于刀耕火种的时代,要么自己去计算rem值,要么依靠编辑器安装插件转换. 而本文的目标就是通过一系列的配 ...