MyEclipse注释配置

  1. 配置路径

1.1.      JAVA

打开MyEclipse,选择Window>Preferences>Java>Code Style>Code Templates>Comments.

1.2.      JS

打开MyEclipse,选择Window>Preferences>MyEclipse>Files and Editors>JavaScript> Code Style> Code Templates>Comments.

  1. 配置说明

2.1.      Files(类文件注释)

l  使用范围

对class文件进行说明。

l  触发机制

新建class文件时触发,增加在class文件最顶部。

l  配置内容


/*

* @title: ${file_name}

* @package:${package_name}

* @description:${todo}

* @author: [email protected]

* @date: ${date} ${time}

* @version:V1.0

*/

l  配置说明

title: 文件名称;

package:文件所在报名;

description:文件功能描述;

author:作者;

date:创建时间;

version:版本;

2.2.      Types(类注释)

l  使用范围

对class类进行说明。

l  触发机制:

在class类方法前使用:”/**“+回车。

l  配置内容:


/**

* @className: ${type_name}

* @description:${todo}

* @author: [email protected]

* @date: ${date} ${time}

* ${tags}

*/

l  配置说明:

className: 类名称;

description:文件功能描述;

author:作者;

date:创建时间;

2.3.      Fields(变量注释)

l  使用范围

对类中的变量进行注释。

l  触发机制:

l  配置内容:


/**

* @fields ${field} ${field_type} :${todo}

*/

l  配置说明:

fields: 变量名称,类型:作用;

2.4.      Methods(方法注释)

l  使用范围

对class类中的方法进行说明。

l  触发机制:

在方法前使用:”/**“+回车。

l  配置内容:


/**

* @title: ${enclosing_method}

* @description:${todo}

* @author: [email protected]

* ${tags}

* @date:${date}${time}

*/

l  配置说明:

title:方法名

description:文件功能描述;

author:作者;

* ${tags} ${return_type}:参数和返回值类型

date:创建时间;

throws:抛出哪些异常

2.5.      Overriding Methods(方法注释)

l  使用范围

对class类中的方法进行重写的方法进行说明。

l  触发机制:

在方法前使用:”@ Overriding“。

l  配置内容:


/**

* @title: ${enclosing_method}

* @description:${todo}

* @author: [email protected]

* ${tags}

* @date:${date}${time}

*/

l  配置说明:

title:方法名

description:文件功能描述;

author:作者;

* ${tags} ${return_type}:参数和返回值类型

date:创建时间;

throws:抛出哪些异常

模版文件:

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

* ${enclosing_method}(这里用一句话描述这个方法的作用)  

* TODO(这里描述这个方法适用条件 – 可选)  

* TODO(这里描述这个方法的执行流程 – 可选)  

* TODO(这里描述这个方法的使用方法 – 可选)  

* TODO(这里描述这个方法的注意事项 – 可选)  

* @param   name  

* @param  @return    设定文件  

* @return   DOM对象  

* @Exception 异常对象  

* @since  CodingExample Ver(编码范例查看) 1.1  

*/
</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">
/**
* fileName:${file_name}
*
* versionInfo:
* date:${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.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">
/**
*
* projectName:${project_name}
* typeName:${type_name}
* classDescription:
* author:yubo
* createTime:${date} ${time}
* modifiedName:
* modifiedTime:${date} ${time}
* remarks:
* @version
*
*/</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">
/**  

* ${enclosing_method}(这里用一句话描述这个方法的作用)  

* TODO(这里描述这个方法适用条件 – 可选)  

* TODO(这里描述这个方法的执行流程 – 可选)  

* TODO(这里描述这个方法的使用方法 – 可选)  

* TODO(这里描述这个方法的注意事项 – 可选)  

* @param   name  

* @param  @return    设定文件  

* @return   DOM对象  

* @Exception 异常对象  

* @since  CodingExample Ver(编码范例查看) 1.1  

*/
</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">
/**
* fileName:${file_name}
*
* versionInfo:
* date:${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.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">
/**
*
* projectName:${project_name}
* typeName:${type_name}
* classDescription:
* author:yubo
* createTime:${date} ${time}
* modifiedName:
* modifiedTime:${date} ${time}
* remarks:
* @version
*
*/</template>

</templates> 

附录:Eclipse针对java代码模板的内置变量
cursor 将编辑器的光标放在这个位置。 N/A
date 插入当前日期。
dollar 插入货币的文字符号。 $
elemType 尝试猜测具有给定 ID 的这个元素的类型。 MyType
enclosing_method 插入模板被插入其中的那个方法的名称。 method()
enclosing_method_arguments 为包围方法插入参数。 arg1, arg2
enclosing_package 插入当前类的包名。 com.example.ui
enclosing_project 插入包含所编辑的这个类的项目的名称。 myProject
enclosing_type 插入正在编辑的类型(类)的名称。 MyType
exception_variable_name 插入一个异常变量名称,进行最佳猜测。 e, ioe
file 文件的简称。 MyType.java
import 如果尚未导入,那么针对给定类型插入一个导入声明。 import com.example.ui.MyOtherType
importStatic 与 import 相同,只不过是静态导入。 import static com.example.ui.MyOtherType.*
line_selection 将选中的行插入到这里。这对用模板包装行是很有用的。 以选中行作为主体的 do、while 循环
primary_type_name 没有扩展名的文件简称。 MyType
time 插入当前的时间。
todo 注释中的 TODO 标记。 TODO
user 当前用户的名字。 ngood
var 解析为本地变量,如果不只一个,就提供一个列表。 myvar
word_selection 插入当前选中的单词。 N/A
year 将现在的年份插入到代码中。 2010

MyEclipse注释配置,布布扣,bubuko.com

时间: 07-28

MyEclipse注释配置的相关文章

MyEclipse基础配置

1.设置默认工作空间编码 window/preferences/general/workspace/Text file encoding 2.设置文件默认打开方式 xml建议设置 html建议设置 jsp建议设置 3.file->new快捷键 在工具条的任意位置,右键(或 window / Customize Perspective) 4.快捷键 http://blog.csdn.net/simon_1/article/details/7708949 •内容提示(Content Assist):

MyEclipse个性化配置

转载自:http://blog.csdn.net/chen_zw/article/details/18728529 MyEclipse个性化配置 1.修改项目文件默认编码 Note:myEclipse默认的编码是GBK, 也就是未设置编码格式的文件都默认使用GBK进行编码, 而更糟糕的是JSP.JavaScriptt默认编码竟然是ISO-8859-1,我们知道ISO-8859-1是不支持中文字符的,所以我们必须修改项目文件的默认编码.         步骤一.修改缺省默认编码:[window]-

myeclipse中配置spring xml自动提示

这是一篇分享技巧的文章:myeclipse中配置spring xml自动提示. ① window -> preferences -> MyEclipse -> Files and Editors -> XML -> XML Catalog ② 选择User Specified Entries,点击add按钮弹出一个选框,填入以下三项 i. Location: D:\baiduyun\Spring\spring_doc\soft\spring-framework-2.5.6\d

Hibernate笔记①--myeclipse制动配置hibernate

Hibernate 是一个开放源代码的对象关系映射框架,它对JDBC进行了非常轻量级的对象封装,使得Java程序员可以随心所欲的使用对象编程思维来操纵数据库. Hibernate可以应用在任何使用JDBC的场合,既可以在Java的客户端程序使用,也可以在Servlet/JSP的Web应用中使用,最具革命 意义的是,Hibernate可以在应用EJB的J2EE架构中取代CMP,完成数据持久化的重任. Hibernate笔记①--myeclipse制动配置hibernate

在MyEclipse中配置android开发环境

在MyEclipse中配置android开发环境.首先要先安装好java jdk,,然后再安装MyEclipse,并正确配置jdk,即在命令提示符下输入java和javac会出现相应的使用命令说明.下载android SDK,解压(最好解压到MyEclipse安装目件夹下进行安装,我的因为已经安装好了,所以这里没有解压到MyEclipse目录下)如下图所示: 打开该文件夹,运行SDK Manager.exe: 打开可能会有点慢, 选择相应的android API版本,再单击下面的install按

JDK TOMCAT MAVEN在myeclipse如何配置

对于没有基础的人来说,本工具务必放在D盘根目录下. 1配置环境变量, "我的电脑-->右键-->属性" 貌似是这样吧,我电脑桌面没"我的电脑"或"计算机" 打开"高级系统设置" 打开"环境变量",我电脑已经配置过对应的变量了,所以不需要在配置了,这时候我只是教大家配置下而已. 点击"新建",看下图,别说不知道点那个新建,填写对应信息,如下 Java环境变量的配置 JAVA_H

Hibernate实现有两种配置,xml配置与注释配置

hibernate实现有两种配置,xml配置与注释配置. (1):xml配置:hibernate.cfg.xml (放到src目录下)和实体配置类:xxx.hbm.xml(与实体为同一目录中) <?xml version='1.0' encoding='utf-8'?> <!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "ht

手把手教你----MyEclipse中 配置 Tomcat

电脑上配置Tomcat服务器 安装Tomcat并配置环境变量 测试是否配置成功 MyEclipse中配置Tomcat 想要开发Java Web的程序,首先在MyEclipse中必须配置Tomcat,一起来动手操作吧. 电脑上配置Tomcat服务器 安装Tomcat并配置环境变量 官网上下载Tomcat,记住你下载安装的版本,后面再MyEclipse中配置的时候会用到,安装时记住你安装的目录,安装成功后,配置环境变量,在系统环境变量中新建 输入的内容如下: 变量名:CATALINA_HOME 变量

在Myeclipse中配置Maven

第一步:安装maven 第二步:在eclipse4.0之前的版本需要安装maven插件,方法即:将maven插件包复制到eclipse安装目录的dropins文件夹下,安装之后版本的eclipse和myeclipse,无需安装插件.本人是用的myeclipse,所以此步没有演示. 第三步:在myclipse中配置maven (1)添加maven的默认配置,更改为本地的maven (2)修改settings.xml路径 第四步:创建maven项目:new→other→maven project→两