`

Myeclipe注释全解析

阅读更多

 

本文转载自http://blog.csdn.net/longxia1987/article/details/6163514

Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit 

/**   
*    
* 项目名称:${project_name}   
* 类名称:${type_name}   
* 类描述:   
* 创建人:${user}   
* 创建时间:${date} ${time}   
* 修改人:${user}   
* 修改时间:${date} ${time}   
* 修改备注:   
* @version    
*    
*/

----------------------------------------------------------------------------------------------------------

设置注释模板的入口: 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}

*/

简单模板例子:

view plaincopy to clipboardprint?

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**

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

*/

</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**

* @return ${bare_field_name}

*/

</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**

* <p>Title:${file_name} </p>

* <p>Description: 构造函数</p>

* ${tags}

*/

</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**   

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}(用一句话描述该文件做什么)

* @author DAIGUANGJIU    

* @date ${date} ${time}

* @version V1.0   

*/

</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**

* @param ${param} 要设置的 ${bare_field_name}

*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**

* @author ${user}

*

* ${tags}

*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**

* ${tags}

* ${see_to_target}

*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**

* ${tags}

*/</template></templa

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**

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

*/

</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**

* @return ${bare_field_name}

*/

</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**

* <p>Title:${file_name} </p>

* <p>Description: 构造函数</p>

* ${tags}

*/

</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}(用一句话描述该文件做什么)

* @author DAIGUANGJIU  

* @date ${date} ${time}

* @version V1.0

*/

</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**

* @param ${param} 要设置的 ${bare_field_name}

*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**

* @author ${user}

*

* ${tags}

*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**

* ${tags}

* ${see_to_target}

*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**

* ${tags}

*/</template></templa

例子2:

view plaincopy to clipboardprint?

<?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: wangxiongdx@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: wangxiongdx@163.com  

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

     */  

    </template>

   

</templates>

分享到:
评论

相关推荐

    myeclipse注释模板的修改 自动生成注释

    在提供的压缩包文件中,"myeclipse注释模板的修改"和"getset注释模板 操作步骤"这两个文件可能包含了详细的图文教程,帮助你更直观地了解每个步骤。通过阅读这些文档,你可以更加熟练地掌握MyEclipse注释模板的修改...

    MyEclipse注释模板

    一、MyEclipse注释模板概述 MyEclipse的注释模板允许开发者自定义各种类型的注释格式,如类注释、方法注释、变量注释等。这些模板可以快速插入到代码中,减少手动输入的时间,同时保证注释的一致性和完整性。通过...

    解决myeclipse .class文件源码问题

    需要注意的是,反编译的结果可能与原始源代码略有不同,因为反编译过程是对字节码进行逆向工程,可能会丢失注释、原始变量名以及一些编译器优化信息。尽管如此,对于理解和调试`.class`文件来说,反编译结果通常足够...

    myeclipse装反编译

    反编译工具,如JAD,可以解析Java字节码(.class文件)并将其转换为接近原始源代码的形式。JAD.exe就是一个常见的Java反编译器,它可以用来查看Java类文件的源代码。 安装反编译插件的过程通常包括以下步骤: 1. ...

    myeclipse 反编译插件

    【标题】:myeclipse ...7. **注意事项**:反编译的源代码可能并不完全与原始源代码一致,因为反编译过程会丢失某些元数据和注释。此外,反编译可能存在法律风险,如果涉及到版权保护的代码,应确保有合法的使用权限。

    myeclipse js插件 spket 下载

    **标题与描述解析** 标题"myeclipse js插件 spket 下载"指的是在MyEclipse集成开发环境中安装SPket JavaScript插件的过程。SPket是一款强大的JavaScript开发工具,它为MyEclipse提供了丰富的JavaScript开发支持,...

    MyEclipse10 反编译

    在MyEclipse10中,反编译插件通常是JAD (Java Decompiler) 或 FJDC (Fast Java Decompiler),这些插件能够将.class文件解析回接近原始Java源代码的形式,尽管不能保证完全恢复到最初的状态,但通常可以理解代码的...

    MyEclipse 设置

    在`Window &gt; Preferences &gt; MyEclipse &gt; Files and Editors &gt; JSP &gt; Encoding`中,可以指定JSP文件的默认编码,确保页面在不同环境中正确解析。 #### 5. **HTML视觉设计(Visual Designer)** 在`Window &gt; ...

    myeclipse前端开发插件spket

    无论是缩进、换行还是注释,Spket都可以按照预设的规则进行自动格式化,使得团队协作时的代码风格更加统一,方便代码审查和维护。 除此之外,Spket还具备错误检查和快速修复能力。当你的代码存在语法错误或潜在问题...

    MyEclipse开发实例

    #### 四、工程元数据文件解析 - **元数据文件**: - `.project`:定义了项目的基本属性,如项目类型等。 - `.classpath`:定义了项目的编译路径。 - `.mymetadata`:MyEclipse特有元数据文件,用于存储项目配置...

    myeclipse 10反编译组件及安装使用说明

    此时,myeclipse将尝试使用新安装的反编译插件解析.jar中的.class文件。 2. 查看源代码:成功反编译后,你将看到类似于Java源代码的文本,尽管可能与原始代码结构略有不同,但仍可以理解其功能和逻辑。 3. 注意...

    myeclipse开发的天气预报项目代码

    学习者可以从中了解到如何使用Java进行网络编程,如何解析JSON或XML数据,如何设计和实现用户界面,以及如何在MyEclipse中进行项目管理和调试。同时,通过阅读和分析代码,还可以加深对Java Web开发流程的理解,提升...

    Myeclipse8.5集成CheckStyle(图解)

    《MyEclipse 8.5 集成 CheckStyle 全面解析》 在软件开发过程中,代码质量是至关重要的,而CheckStyle就是这样一款用于确保代码质量的静态代码分析工具。它通过检查代码是否遵循特定的编码规范,帮助开发者保持代码...

    Myeclipse8.5 反编译插件

    - **源代码质量**:由于反编译的过程是基于字节码的逆向工程,生成的源代码可能与原始代码有所不同,包括变量名、注释等细节,但逻辑结构应该基本保持一致。 - **版权问题**:反编译他人的代码可能存在法律风险,...

    MyEclipse配色字体等配置的解决方案.txt

    以下是对标题、描述及部分给定内容中的知识点进行详细解析。 #### 知识点一:如何修改MyEclipse的配色方案 在MyEclipse中,用户可以通过以下步骤来调整代码编辑器的颜色配置: 1. **打开首选项**: 选择菜单栏中的 `...

    myeclipse.ini

    ### myeclipse.ini 文件解析与知识点详解 #### 一、myeclipse.ini 文件概述 `myeclipse.ini` 是 MyEclipse 启动时读取的配置文件之一,用于设置 MyEclipse 的运行参数,包括 JVM(Java Virtual Machine)参数等。...

    myeclipse对象建模设计.txt

    部分文本虽然格式混乱,但可以解析出几个关键点: 1. E-R模型(实体关系模型)被提及,这是数据库设计的一个基础概念,用于描述现实世界中的数据实体及其之间的关系。在软件设计中,将E-R模型转换为更具体的对象模型...

    myeclipse反编译插件及安装方法

    在Java领域,JAD(Java Decompiler)是一种常用的反编译工具,它可以解析Java字节码并生成接近原生的Java源代码。 MyEclipse作为一款强大的Java EE集成开发环境,提供了许多插件来扩展其功能。对于反编译需求,我们...

    MyEclipse反编译插件jar包及exe

    JAD(Java Decompiler)是一款著名的开源反编译工具,它可以解析Java字节码并生成类似于原始源代码的文本。jadclipse插件与jad.exe的结合,使得MyEclipse用户可以直接在IDE内方便地查看和分析第三方库或未知类的源...

Global site tag (gtag.js) - Google Analytics