竭诚为您提供优质文档/双击可除eclipse,代码模板下载
篇一:eclipse代码模板功能完整初级入门
eclipse代码模板技术
例子:
什么是代码模板呢举个例子,一个很常见的应用,如何在一个类中中建立一个main函数
正常情况下需要全部代码手动打出来:
但是,是不是应该思考下,对于这种非常固定的代码,有必要一个字母一个字母的敲吗作为ide,其中一个设计哲学就是能帮用户干的就帮用户干,像上面这种情况,就该是eclipse代码模板发挥作用的时候。
我们只需在类体中键入main,然后使用eclipse的代码提示快捷键(默认为alt+/),回车后,就可以看到eclipse 自动帮我们完成了main函数的完整定义。
1、代码模板查看
打开
windows->preferences->java->editor->templates,可以看到所有已定义的代码模板列表。
例子:
1、
在代码中经常需要在控制台输出一些数据
system.out.pringln("hello,world");
以前如果你已经习惯了一个字母一个字母的打的话,那么现在你可以尝试一下键入sysout,然后按alt+/。
2、
在编程中有时还会遇到另一类问题,比如我想把某些代码加到try/catch块中,进行异常检测。在代码模板的帮助下,你完全不用手工键入这部分代码,也不用去管代码缩进,你只需要选中要处理的代码块,然后按alt+shift+z,回车后,eclipse会自动为所选代码块包上try/catch语句。
操作实例:
我们以一个很现实的例子来说明,在实际开发中,经常会需要测试某段代码的执行时间,一般来说我们会使用以下方法。
分别记录代码执行前和执行后的时间戳,然后计算两个时间戳的差值。这段代码是非常固化的,如果每次都手工敲入,很令人崩溃,但是如果使用“代码模板”功能来做,就方便多了。
步骤:
1、
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍: 文件(Files)注释标签: /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author chenguang * @date ${date} ${time} * @version V1.0 */ 类型(Types)注释标签(类的注释): /** * 类功能说明 * 类修改者修改日期 * 修改说明 * Title: ${file_name} * Description:清大海辉科技开发平台 * Copyright: Copyright (c) 2006 * Company:北京清大海辉科技有限公司 * @author ${user} * @date ${date} ${time} * @version V1.0 */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo} */ 构造函数标签: /** * Title: * Description: * ${tags} */
方法(Constructor & Methods)标签: /** * 函数功能说明 * ${user} ${date} * 修改者名字修改日期 * 修改内容 * @param ${tags} * @return ${return_type} * @throws */ getter方法标签: /** * @return ${bare_field_name} */ setter方法标签: /** * @param ${param} ${bare_field_name} */ 加注释快捷键:选中你要加注释的方法或类,按Alt + shift + J。
javadoc 是j2sdk里面一个非常重要的工具,如果你按照规范在java的源代码里面写好注释的话,那么它就可以生成相应的文档。开发者察看起来会非常方便。很多IDE都可以直接生成javadoc的,这里介绍如何写javadoc以及如何在eclipse下生成javadoc。 javadoc通常从package、公开类或者接口、公开或者受保护的字段、公开或者受保护的方法提取信息。每条注释应该是以/**开始以*/结尾。例如 /** * * @param id the coreID of the person * @param userName the name of the person * you should use the constructor to create a person object */ public SecondClass(int id,String userName) { this.id = id; https://www.doczj.com/doc/756134426.html,erName = userName; } 注释应该写在要说明部分的前面,如上所示。并且在其中可以包括html的标记,如果上面没有标记的话,那么you should usr the ......将会在javadoc里面紧跟@param userName....,这样不是我们希望的。一般注释可以分为类注释、方法注释、字段注释等。下面分别作简单的介绍 类注释 类注释应该在import语句的后面在类声明的前面,比如 package com.north.java; /** * @author ming * * this interface is to define a method print() * you should implements this interface is you want to print the username * @see com.north.ming.MainClass#main(String[]) */ public interface DoSomething { /** * @param name which will be printed * @return nothing will be returned * */
网上资料:共享 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: * @author: 秦天朋 * @date ${date} ${time} * * ${tags} */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */ 构造函数标签: /** * Title: * Description: * ${tags} */ 方法(Constructor & Methods)标签: /**
在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个《Java的注释规范》,内容来自网络、书籍和自己的实际积累。 JA V A注释规范 版本/状态作者版本日期 1.0 ghc 2008-07-02 一、背景 1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2、怎么样避免我们的注释冗长而且凌乱不堪呢? 3、在多人协同开发、维护的今天,我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢? 二、意义 程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本, 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯,甚至锻炼出更加严谨的思维能力。 三、注释的原则 1、注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同,按照他们的规范写代码,不要试图在既成的规范系统中引入新的规范。 2、注释的简洁 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。 3、注释的一致性 在写代码之前或者边写代码边写注释,因为以后很可能没有时间来这样做。另外,如果有机会复查已编写的代码,在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建,解释性注释在开发过程中创建,提示性注释在代码完成之后创建。修改代码的同时修改相应的注释,以保证代码与注释的同步。 4、注释的位置 保证注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置,不可放在下方。避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释要对齐。 5、注释的数量 注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”,而不是文档,程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。不要被动的为写注释而写注释。 6、删除无用注释
IDEA类和方法注释模板设置 作者:wRitchie 来源:https://www.doczj.com/doc/756134426.html, IDEA自带的注释模板不是太好用,整理了一下制作了一份比较完整的模板,这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置: 类注释模板: 方法注释模板: 一、首先我们来设置IDEA中类的模板: 设置类注释模板 1.选择File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
2、效果图展示 IDEA没有智能到自动创建方法注释,需手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,也按照这种习惯来设置IDEA的方法注释 1、File-->Settings-->Editor-->Live Templates
(1)新建组:命名为wRitchie (2)新建模板:命名为*
注:因为IDEA生成注释的默认方式是:/*+模板名+快捷键(例:若设置模板名为add,快捷键用Tab,则生成方式为/*add+Tab)若不采用这样的生成方式,IDEA中没有内容的方法将不可用,例如:获取方法参数的methodParameters()、获取方法返回值的methodReturnType() (3)设置生成注释的快捷键 (4)设置模板 模板内容如下,注意第一行,只有一个“*”而不是“/*”,在设置参数名时必须用:${参数名}$的方式,否则第五步中读取不到你设置的参数名 * * @Author: wRitchie * @Description: $description$ * @Param: $params$ * @return: $returns$ * @Date: $date$ $time$
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments 节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍: 文件(Files)注释标签: /** * @Project: ${project_name} * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author jeffshaw jeff_chon@https://www.doczj.com/doc/756134426.html, * @date ${date} ${time} * @Copyright: ${year} https://www.doczj.com/doc/756134426.html, Inc. All rights reserved. * @version V1.0 */ 类(Types)注释标签(类的注释): /** * @ClassName: ${type_name} * @Description: ${todo} * @author jeffshaw jeff_chon@https://www.doczj.com/doc/756134426.html, * @date ${date} ${time} * * ${tags} */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo} */ 构造函数标签: /** * Title: * Description:
* ${tags} */ 方法(Constructor & Methods)标签: /** * @Title: ${enclosing_method} * @Description: ${todo} * @param ${tags} 设定文件 * @return ${return_type} 返回类型* @throws */ 覆盖方法(Overriding Methods)标签: /* (非 Javadoc) * Title: ${enclosing_method} * Description: * ${tags} * ${see_to_overridden} */ 代表方法(Delegate Methods)标签: /** * ${tags} * ${see_to_target} */ getter方法标签: /** * @return ${bare_field_name} */
JAVA代码注释规范 目录 JA V A代码注释规范 (1) 注释的原则 (1) 注释的简洁 (1) 注释的一致性 (1) 注释的位置 (2) 注释的数量 (2) 删除无用注释 (2) 复杂的注释 (2) 多余的注释 (2) 必加的注释 (3) JA V A注释技巧 (3) JA V A注释具体实现 (4) 源文件注释 (4) 类(模块)注释: (5) 接口注释: (5) 构造函数注释: (6) 方法注释: (6) 方法内部注释: (7) 全局变量注释: (7) 局部(中间)变量注释: (7) 常量 (7) p.s. 注释使用统一的注释文件 (8) 注释的原则 注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同, 按照他们的规范写代码,不要试图在既成的规范系统中引入新的规范。 注释的简洁 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。 注释的一致性
在写代码之前或者边写代码边写注释,因为以后很可能没有时间来这样做。另外,如果有机会复查已编写的代码, 在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建,解释性注释在开发过程中创建, 提示性注释在代码完成之后创建。修改代码的同时修改相应的注释,以保证代码与注释的同步。 注释的位置 保证注释与其描述的代码相邻,即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置,不可放在下方。 避免在代码行的末尾添加注释;行尾注释使代码更难阅读。不过在批注变量声明时,行尾注释是合适的;在这种情况下,将所有行尾注释要对齐。 注释的数量 注释必不可少,但也不应过多,在实际的代码规范中,要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”,而不是文档, 程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。不要被动的为写注释而写注释。 删除无用注释 在代码交付或部署发布之前,必须删掉临时的或无关的注释,以避免在日后的维护工作中产生混乱。 复杂的注释 如果需要用注释来解释复杂的代码,请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码,而应该重写它。 尽管一般不应该为了使代码更简单便于使用而牺牲性能,但必须保持性能和可维护性之间的平衡。 多余的注释 描述程序功能和程序各组成部分相互关系的高级注释是最有用的,而逐行解释程序如何工作的低级注释则不利于读、写和修改,是不必要的, 也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释,避免多余的或不适当的注释出现。
案卷号 日期2009/10/7 一卡通管理程序说明 详细设计说明书 作者:唐庆龙 完成日期:2009/10/7 签收人:老师 签收日期:2009/10/10 修改情况记录: 版本号修改批准人修改人安装日期签收人
目录 1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3定义 (1) 1.4参考资料 (1) 2程序系统的结构 (1) 3程序1(标识符)设计说明 (2) 3.1程序描述 (2) 3.2功能 (2) 3.3性能 (2) 3.4输入项 (2) 3.5输出项 (2) 3.6算法 (3) 3.7流程逻辑 (3) 3.8接口 (3) 3.9存储分配 (3) 3.10注释设计 (3) 3.11限制条件 (3) 3.12测试计划 (3) 3.13尚未解决的问题 (4) 4程序2(标识符)设计说明 (4)
1引言 1.1编写目的 说明编写这份详细设计说明书的目的,指出预期的读者范围。 1.2背景 说明: a.待开发的软件系统的名称; b.列出本项目的任务提出者、开发者、用户以及将运行该项软件的单位。 1.3定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4参考资料 列出要用到的参考资料,如: a.本项目的经核准的计划任务书或合同、上级机关的批文; b.属于本项目的其他已发表的文件; c.本文件中各处引用的文件、资料,包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位,说明能够得到这些文件资料的来源。 2程序系统的结构 用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系。
Eclipse Java注释模板设置详解 分类:Java编程思想2011-10-07 14:31 67人阅读评论(0) 收藏举报 设置注释模板的入口: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}(用一句话描述这个变量表示什么) */ 构造函数标签: /** * Title: * Description: * ${tags} */
方法(Constructor & Methods)标签: /** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @param ${tags} 设定文件 * @return ${return_type} 返回类型 * @throws */ 覆盖方法(Overriding Methods)标签: /* (非Javadoc) * Title: ${enclosing_method} * Description: * ${tags} * ${see_to_overridden} */ 代表方法(Delegate Methods)标签: /** * ${tags} * ${see_to_target} */ getter方法标签: /** * @return ${bare_field_name} */ setter方法标签: /** * @param ${param} 要设置的${bare_field_name} */ 简单模板例子:
Info DMS java代码开发模板 作者:周清江 发布日期:2007-11-23 当前版本:0.1 上海英孚思为信息科技有限公司 修订历史纪录 代码开发环境修订Info DMS 英孚思为机密文件
代码开发环境修订Info DMS 英孚思为机密文件
代码开发环境修订 Info DMS 英孚思为机密文件 Java 开发模板文件导入 1. 导入统一的版权信息和类、方法、字段注释格式文件 第一步 打开 Preference,选中 code_style->>Code_Templates 第二步选择Import … 文件名:code_style_templates.xml
代码开发环境修订 Info DMS 英孚思为机密文件 2. 导入统一代码样式文件 第一步 打开 Preference,选中code_style->>Fromatter
代码开发环境修订 Info DMS 英孚思为机密文件 第二步选择Import … 文件名: code_style_formatter.xml
File Descript统一定义 导入统一的版权信息以后当新建每个JA V A以后,JA V A文件头内容统一为:/** *Copyright(c)2006-2008OEM Infoservice Corp.2006-2008,All Rights Reserved. *This software is published under the Infoservice DMS Service Inner Solution Team. *License version 1.0,a copy of which has been included with this *distribution in the LICENSE.txt file. * *@File name: https://www.doczj.com/doc/756134426.html,base.actions.MaintainBrand.java *@Create on:2007-9-30 *@Author:kevin * *@ChangeList *--------------------------------------------------- *NO Date Editor ChangeReasons * 1.2007-9-30kevin Add * */ 注意: 1.如果文件不是新建而是从原来的项目中拷贝过来,请修改包名 和类名.(@File name:) https://www.doczj.com/doc/756134426.html,base.actions.MaintainBrand.java 2.如果因为重要的业务逻辑而修改过文件,不要忘了在(@ChangeList)加上相关修改日期、修改人和简单描述修改原因。 Class Body( Action) 描述内容 在一些业务比较简单的Action文件中Class Body内容没有设置,这样生成的JA V ADOC文档中这些Action就很难读懂。对于业务相对简单的Action也需对该业务内容做简单的描述,如下: 代码开发环境修订Info DMS 英孚思为机密文件
在java中有三种书写注释的方式:“//...”、“/*...*/”、“/**...*/”。(不带双引号“”,...代表被注释 的内容) 1、“//” 这是一种最常使用的方式,此种注释只注释一行,即“//”所在行,也就是“//”后面的内容。在 本行注释,有这么几个作用(本人心得啊): 一、方便自己查看:在下次看到代码后,自己可以更加快速的理解这句代码和所在代码块中的作用,以及对上下代码也更容易理解,而不用再一句一句的阅读源代码,从而节省很多时间。 二、方便其他人阅读:如果没有在必要的代码后面加上注释,别人就要把源代码的每一句都要阅读,不利于别人的阅读和其他程序员继续自己未完成的工作。 三、还有一点就是,加上一些注释,显得比较专业。(有些题外话了,不过看着确实如此) 如: [java]view plaincopyprint? 1.System.out.println("Hello World"); //打印字符串“Hello World” 2、“/*...*/” 对于一些较长的注释,也可以用”//“,但是这样就显得很麻烦,所以可以使用” /*...*/ “了,它用于注释若干行。比如说,在编写了很长一段代码后,编译运行后有很多错误出现,一查看,发现某个代码块有问题,这时候,你就可以将这段代码块注释掉,运行后发现问题解决了。这段注释掉的代码就可以用” /*...*/ “来注释。或者你需要在一段代码前写明这段代码的作用及方法等,也可以用” /*...*/ “ 如: [java]view plaincopyprint? 1./* 2.查找数组中的元素 3.折半法:前提是数组是按大小顺序排列好的, 4.用查找的值和中间值比较,大则和下一半中间值比依次,小则和上一半中间值比,找 到则返回。 5.小值的编号在左移或大值的编号在右移。判断是否大小值的编号相遇,若未找到,则 不再循环,返回-1 6. */ 7.public static int FindArry1(int[] arr,int key) 8. { 9.int min,max,mid; 10. min = 0; 11. max = arr.length-1; 12. mid = (min + max)/2;
核心提示:javadoc可以根据项目代码的注释(当然是规范化的)自动生成HTML格式的API文档。 javadoc可以根据项目代码的注释(当然是规范化的)自动生成HTML格式的API文档。 三种注释类型(注释必须紧贴着注释体,不然javadoc会忽略): 类注释 变量注释 方法注释 书写格式: /** <--> * ........ * @XXX <--> */ 参数说明: @see 生成文档中的“参见xx 的条目”的超链接,后边可以加上:“类名”、“完整类名”、“完整类名#方法”。可用于:类、方法、变量注释。 @param 参数的说明。可用于:方法注释。 @return 返回值的说明。可用于:方法注释。 @exception 可能抛出异常的说明。可用于:方法注释。 @version 版本信息。可用于:类注释。 @author 作者名。可用于:类注释。 @deprecated 对类或方法的说明该类或方法不建议使用,引起不推荐使用的警告 @note 表示注解,暴露给源码阅读者的文档 @remark 表示评论,暴露给客户程序员的文档 @since 表示从那个版本起开始有了这个函数 @see 表示交叉参考 javadoc命令: javadoc [options] [packagenames] [sourcefiles] -public 仅显示public 类和成员 -protected 显示protected/public 类和成员(缺省) -package 显示package/protected/public 类和成员 -private 显示所有类和成员 -d 输出文件的目标目录 -version 包含@version 段
设置JAVA注释模板 找到注释模板所在的地方: window → Preference → Java → Code Style → Code Template 然后展开 Comments 节点就是所需要设置注释的元素了: 文件(Files)注释标签: /** * @Project: ${project_name} * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * @author shenyanghong ahong2011@https://www.doczj.com/doc/756134426.html, * @date ${date} ${time} * @Copyright: ${year} * @version V1.0 */
类(Types)注释标签(类的注释): /** * @ClassName ${type_name} * @Description ${todo} * @author shenyanghong ahong2011@https://www.doczj.com/doc/756134426.html, * @date ${date} * ${tags} */ 字段(Fields)注释标签: /** * @Fields ${field} : ${todo} */ 构造函数标签: /** * Title: * Description: * ${tags} */ 方法(Constructor & Methods)标签: /** * @Title: ${enclosing_method} * @Description: ${todo} * @param ${tags} * @return ${return_type} * @throws */ 覆盖方法(Overriding Methods)标签: /* (非 Javadoc) * Title: ${enclosing_method}
Java程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。 实现注释:/*…*/和//,用以注释代码或或者实现细节。 文档注释:/**…*/,可以通过javadoc工具转换成HTML文件,描述代码的规范,可以被那些手头没有源码的开发人员读懂。 程序可以有4种实现注释的风格:块(Block),单行(single-line),尾端(trailing)和行末(end-of-line)。 块注释:用于提供对文件,方法,数据结构和算法的描述。块注释之首应该有一个空行,用于把块注释和代码分割开来。比如: / * * Here is a block comment. */ 块注释可以以/ *-开头,这样indent(1)就可以将之识别为一个代码块的开始,而不会重排它。 / *- * Here is a block comment with some very special * formatting that I want indent(1) to ignore. * * one * two * three */ 单行注释:短注释可以显示一行内,并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该使用块注释,单行注释之前应该有一个空行。 尾端注释:极短的注释可以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。 以下是一个Java代码中尾端注释的例子: if (a ==2) { return TRUE; / * special case */ } else { return isPrime(a); / * works only for odd a */ } 行末注释:注释界定符“//”,可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本;然而,它可以用来注释掉多行的代码段。例子: if(foo > 1) { // Do a double-filp. …… } // if (bar > 1) { // // // Do a triple-filp. // …… // }
myeclipse中java文件头注释格式设置 2011-10-08 13:11:33| 分类: IDE|举报|字号订阅 windows->preferences->java->Code Templates->comments->Type->edit Eclipse注释规范模版总结 新建类文件 /** * @ClassName: ${file_name} * @Description: ${todo}(用一句话描述该文件做什么) * * @author ${user} * @version V1.0 * @Date ${date} ${time} */ 方法 /** * @Title: ${enclosing_method} * @Description: ${todo}(这里用一句话描述这个方法的作用) * @param: ${tags} * @return: ${return_type} * @throws * @author ${user} * @Date ${date} ${time} */ 输入设置模板: /** * ${file_name} Create on ${date} * * Copyright (c) ${date} by taotaosoft * * @author Jerryli * @version 1.0 * */ 注意选择自动添加注释 养成一个规范的习惯是最好的。 选菜单
windows-->preference Java-->Code Style-->Code Templates code-->new Java files 选中点编辑 ${filecomment} ${package_declaration} /** * @author 作者姓名 E-mail: email地址 * @version 创建时间:${date} ${time} * 类说明 */ ${typecomment} ${type_declaration} Eclipse注释规范模版总结 1、具体操作 (1)在eclipse中,打开Window->Preference->Java->Code Style->Code Template (2)然后展开Comments节点就是所有需设置注释的元素,参照2注释规范对应设置即可2、注释规范 (1)文件(Files)注释标签 /** * FileName: ${file_name} * @Description: ${todo}(用一句话描述该文件做什么) * All rights Reserved, Designed By ZTE-ITS * Copyright: Copyright(C) 2010-2011 * Company ZTE-ITS WuXi LTD. * @author: 名字 * @version V1.0 * Createdate: ${date} ${time} * * Modification History: * Date Author Version Discription * * ${date} wu.zh 1.0 1.0 * Why & What is modified: <修改原因描述> */ (2)类型(Types)注释标签(类的注释): /** * @ClassName: ${type_name}
1.准备模板文件codetemplates.xml(将下面的内容复制到你的xml文件中即可使用):