java注释规范
Java编程规范总结

Java编程规范总结命名:1. 为包、类、⽅法、变量取⼀个好名字,使代码易于理解2. 禁⽌使⽤魔⿁数字3. 常量命名,由全⼤写单词组成,单词间⽤下划线分隔,且使⽤ static final修饰4. 变量、属性命名,使⽤名词,并采⽤⾸字母⼩写的驼峰命名法5. ⽅法的命名,⽤动词和动宾结构,并采⽤⾸字母⼩写的驼峰命名法6. 类和接⼝的命名,采⽤⾸字母⼤写的驼峰命名法7. 包的命名,由⼀个或若⼲个单词组成,所有的字母均为⼩写8. 数组声明的时候使⽤ int[] index,⽽不要使⽤ int index[]注释:1. 尽量⽤代码来解释⾃⼰2. 注释应解释代码的意图,⽽不是描述代码怎么做的3. 保证注释与代码⼀致,避免产⽣误导4. 注释应与其描述代码位置相邻,放在所注释代码上⽅或右⽅,并与代码采⽤同样缩进5. 不要⽤注释保留废弃代码6. 不要⽤注释记录修改⽇志7. ⼀般单⾏注释⽤//,块注释⽤,JavaDoc注释⽤排版:1. 团队应遵守⼀致的排版风格2. 将排版风格固化到IDE的代码格式化配置⽂件中,并让整个团队使⽤3. 在不同的概念之间,增加空⾏4. 将逻辑紧密相关的代码放在⼀起5. 控制⼀⾏的宽度,不要超过120个字符6. 在不同的概念间(关键字、变量、操作符等)增加空格,以便清楚区分概念7. 采⽤缩进来区分不同层次的概念8. 将局部变量的作⽤域最⼩化9. 给if、for、do、while、switch等语句的执⾏体加⼤括号{}10. 控制⽂件的长度,最好不要超过500⾏变量和类型:1. 谨慎使⽤静态成员变量2. 避免随意进⾏类型强制转换,应改善设计,或在转换前⽤instanceof进⾏判断33. 需要精确计算时不要使⽤float和double4. 不能⽤浮点数作为循环变量5. 浮点型数据判断相等不能直接使⽤==6. 避免同⼀个局部变量在前后表达不同的含义7. 不要在单个的表达式中对相同的变量赋值超过⼀次8. 基本类型优于包装类型,注意合理使⽤包装类型⽅法:1. ⽅法设计的第⼀原则是要短⼩2. ⽅法设计应遵循单⼀职责原则(SRP),⼀个⽅法仅完成⼀个功能3. ⽅法设计应遵循单⼀抽象层次原则(SLAP)4. ⽅法设计应遵循命令与查询职责分离原则(CQRS)5. 不要把⽅法的⼊参当做⼯作变量/临时变量,除⾮特别需要6. 使⽤类名调⽤静态⽅法,⽽不要使⽤实例或表达式来调⽤7. 应明确规定对接⼝⽅法参数的合法性检查由调⽤者负责还是由接⼝⽅法本⾝负责8. ⽅法的参数个数不宜过多9. 谨慎使⽤可变数量参数的⽅法包、类和接⼝:1. 类和接⼝的设计应遵循⾯向对象SOLID设计原则2. 类的设计应遵循迪⽶特法则3. 类的设计应遵循“Tell,Don't ask”原则4. 类设计时优选组合⽽不是继承5. 除提供给外部使⽤的全局常量外,应尽量避免类成员变量被外部直接访问6. 避免在⽆关的变量或⽆关的概念之间重⽤名字,避免隐藏(hide)、遮蔽(shadow)和遮掩(obscure)7. 覆写(override)——⼦类与⽗类间8. 重载(overload)——类内部9. 隐藏(hide)——⼦类与⽗类间10. 遮蔽(shadow)——类内部11. 遮掩(obscure)——类内部12. 不要在⽗类的构造⽅法中调⽤可能被⼦类覆写的⽅法13. 覆写equals⽅法时,应同时覆写hashCode⽅法14. ⼦类覆写⽗类⽅法时应加上@Override注解15. 接⼝定义中去掉多余的修饰词16. 设计时,考虑类的可变性最⼩化异常:1. 只针对真正异常的情况才使⽤exception机制2. 在抛出异常的细节信息中,应包含能捕获失败的信息3. 对可恢复的情况使⽤受检异常(checked exception),对编程错误使⽤运⾏时异常(runtime exception)4. 不要忽略异常5. ⽅法注释和⽂档中要包含所抛出异常的说明6. ⽅法抛出的异常,应该与本⾝的抽象层次相对应7. 对第三⽅API抛出⼤量各类异常进⾏封装8. 使⽤异常来做错误处理,⽽⾮错误码9. 在finally块中不要使⽤return、break或continue使finally块⾮正常结束10. 不要直接捕获受检异常的基类Exception11. ⼀个⽅法不应抛出太多类型的异常12. 充分利⽤断⾔⽇志:1. ⽇志信息准确、繁简得当,满⾜快速定位的需要2. ⽇志的记录,不要使⽤ System.out 与 System.err 进⾏控制台打印,应该使⽤专⽤的⽇志⼯具(⽐如:slf4j+logback)进⾏处理3. ⽇志⼯具对象logger应声明为private static final4. ⽇志应分等级5. ⽇志中不要记录敏感信息多线程并发:1. 多线程访问同⼀个可变变量,需增加同步机制2. 禁⽌不加控制地创建新线程3. 创建新线程时需指定线程名4. 使⽤Thread对象的setUncaughtExceptionHandler⽅法注册Runtime异常的处理者(v1.5+)5. 不要使⽤Thread.stop⽅法,因为该⽅法本质是不安全的,使⽤它可能会导致数据遭到破坏6. 不要依赖线程调度器、线程优先级和yield()⽅法7. 采⽤Java1.5提供新并发⼯具代替wait和notify(v1.5+)8. 使⽤线程安全集合在多线程间共享可变数据9. 多线程操作同⼀个字符串相加,应采⽤StringBuffer10. 针对线程安全性,需要进⾏⽂档(javadoc)说明运算和表达式:1. 不要写复杂的表达式2. 运算时应避免产⽣溢出3. 采⽤括号明确运算的优先级控制语句:1. 采⽤for-each代替传统的for循环(v1.5+)2. 在switch语句的每⼀个case、和default中都放置⼀条break语句序列化:1. 尽量不要实现Serializable接⼝2. 序列化对象中的HashMap、HashSet或HashTable等集合不能包含对象⾃⾝的引⽤3. 实现Serializable接⼝的可序列化类应该显式声明 serialVersionUID泛型:1. 在集合中使⽤泛型(v1.5+)2. 类的设计可优先考虑泛型(v1.5+)3. ⽅法的设计可优先考虑泛型(v1.5+)4. 优先使⽤泛型集合,⽽不是数组(v1.5+)其他语⾔特性:1. 新代码不要使⽤已标注为@deprecated的⽅法2. 使⽤JDK⾃带的API或⼴泛使⽤的开源库,不要⾃⼰写类似的功能。
java文档注释规范(一)

java⽂档注释规范(⼀)https:///huangsiqian/article/details/82725214Javadoc⼯具将从四种不同类型的“源”⽂件⽣成输出⽂档:Java语⾔类的源⽂件(.java),包注释⽂件,概述注释⽂件和其他未处理的⽂件。
包注释⽂件(Package Comment File)每个包都有⾃⼰的⽂档注释。
有两种⽅式来创建包注释⽂件:package-info.java - 可以包含包的声明,包注解(anotation),包注释和Javadoc 标签(tag)。
包注释放在包声明之前。
这是JDK 5.0新引⼊的特性。
如下。
File: java/applet/package-info.java 注意:⽂档注释块内部⾏⾸的*号是可选的/*** Provides the classes necessary to create an applet and the classes an applet uses* to communicate with its applet context.* <p>* The applet framework involves two entities:* the applet and the applet context. An applet is an embeddable window (see the* {@link java.awt.Panel} class) with a few extra methods that the applet context* can use to initialize, start, and stop the applet.** @since 1.0* @see java.awt*/package ng.applet;package.html - 只能包含包注释和Javadoc标签,不能包含包注解。
java 开发规范

java开发规范(一)java命名规范1、变量、成员、方法名统一采用驼峰命名(lowerCamelCase),做到见语知其义例子:变量——用户数据(userList)、方法——getUserData(int type)等。
说明:正常变量定义使用驼峰命名,特殊的如DTO\VO\DO等除外。
2、类名的定义(1)普通类名采用大写字母开始;(2)抽象类采用Abstract或Base开头。
例子:普通类——class UserModel,抽象类——abstract class AbstractUserDefinition等。
3、常量、类型、接口、子类的定义(1)常量使用全大写且单词之间用"_“隔开; (2)boolean变量不能使用is开头;(3)接口尽量不要修饰符、子类紧跟接口追加Impl。
例子:常量——SORT_TYPE,布尔类型——flag,接口——UserService,实现类——UserServiceImpl等。
说明:常量不可组装,需要原子性定义,不能出现"KEY”+SORT_TYPE 这种内部出现。
4、包名、异常、枚举、方法名称的定义(1)包名一律采用小写; (2)异常都采用_Exception结尾; (3)枚举都是以Enum结尾;(4)方法名称——根据方法内容采用如插入insert-*。
例子:异常——UserException,包名——com.test,枚举——UserEnum,方法名称——insertUser等。
5、领域模型定义规范:主要是以VO\DTO\DO等结尾例子:用户数据——UserDTO等(1)数据对象:xxxDO,xxx 即为数据表名。
(2)数据传输对象:xxxDTO,xxx为业务领域相关的名称。
(3)展示对象:xxxVO,xxx一般为网页名称。
(4)POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。
(二)代码格式规范1、括号代码要求左大括号前不换行、左大括号后换行、右大括号前换行、右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。
java代码注释规范

java代码注释规范展开全文一、规范存在的意义应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因:1、好的编码规范可以尽可能的减少一个软件的维护成本, 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;3、好的编码规范可以最大限度的提高团队开发的合作效率;4、长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;二、命名规范1、一般概念1、尽量使用完整的英文描述符2、采用适用于相关领域的术语3、采用大小写混合使名字可读4、尽量少用缩写,但如果用了,必须符合整个工程中的统一定义5、避免使用长的名字(小于 15 个字母为正常选择)6、避免使用类似的名字,或者仅仅是大小写不同的名字7、避免使用下划线(除静态常量等)2、标识符类型说明1、包( Package )的命名Package 的名字应该采用完整的英文描述符,都是由一个小写单词组成。
并且包名的前缀总是一个顶级域名,通常是 com、edu、gov、mil、net、org 等;如: com.yjhmily.test2、类( Class )的命名类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。
尽量保证类名简洁而富于描述。
使用完整单词,避免缩写词( 除非工程内有统一缩写规范或该缩写词被更广泛使用,像 URL , HTML)如: FileDescription3、接口( Interface )的命名基本与 Class 的命名规范类似。
在满足 Classd 命名规则的基础之上,保证开头第一个字母为”I”,便于与普通的 Class区别开。
其实现类名称取接口名的第二个字母到最后,且满足类名的命名规范;如: IMenuEngine4、枚举( Enum )的命名基本与 Class 的命名规范类似。
在满足 Classd 命名规则的基础之上,保证开头第一个字母为”E” ,便于与普通的 Class区别开。
JAVA代码注释规范

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%左右。
注释是对代码的“提示”,而不是文档,程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱,注释的花样要少。
不要被动的为写注释而写注释。
删除无用注释在代码交付或部署发布之前,必须删掉临时的或无关的注释,以避免在日后的维护工作中产生混乱。
idea java 多行注释

一、概述在Java编程语言中,注释是一种非常重要的语法元素,用于向程序的读者解释代码的作用,或者是临时屏蔽某些代码片段。
Java中有单行注释和多行注释两种方式,本文将重点介绍多行注释的使用方法和相关注意事项。
二、多行注释的格式多行注释是指可以跨越多行的注释形式,在Java中使用/*和*/包括起来的内容即为多行注释。
其格式如下:/*这是一段多行注释可以跨越多行*/三、多行注释的使用场景多行注释主要用于以下几种情况:1. 对代码进行较为详细的注释说明,方便程序的阅读与理解。
2. 临时屏蔽一段代码,调试程序或查找错误时使用,相比于单行注释更加便利。
3. 用于生成文档,许多Java文档生成工具可以自动提取多行注释的内容,生成类、方法等的说明文档。
四、多行注释的注意事项在使用多行注释时,需要注意以下几点:1. 多行注释不能嵌套,即/* */之间不能再包含/* */形式的注释内容。
这可能导致编译错误。
2. 多行注释不能出现在字符串常量中,否则编译器也会发出错误提示。
3. 多行注释不能出现在代码中的任何位置,只能以注释的形式独立存在,不能与代码混合在一起。
五、多行注释的最佳实践在实际的Java编程中,应该遵循以下几点关于多行注释的最佳实践:1. 注释要简洁明了,不要写过多无用的注释,遵循“必要的注释”原则。
2. 注释内容应该符合代码的逻辑结构,能够清晰地表达代码的意图。
3. 对于一些复杂算法或者特殊处理逻辑,应当使用多行注释进行详细说明,方便后续的维护和理解。
六、多行注释的案例下面是一个使用多行注释的实际案例,展示了多行注释在Java中的使用方法:/*这是一个计算斐波那契数列的方法参数n代表数列的长度返回一个长度为n的斐波那契数列数组*/public int[] fibonacci(int n) {int[] result = new int[n];result[0] = 0;result[1] = 1;for (int i = 2; i < n; i++) {result[i] = result[i - 1] + result[i - 2];}return result;}七、总结多行注释在Java中是一种非常重要的语法元素,能够帮助开发者、维护者更好地理解和阅读代码。
java 代码规范

java 代码规范Java代码规范是指在Java程序设计中遵循的一些规则和约定,旨在提高代码的可读性、可维护性和可移植性。
遵守代码规范可以帮助团队成员更好地理解和协作开发,提高代码的质量和可靠性。
本文将围绕Java代码规范展开讨论,包括命名规范、代码风格、注释规范、异常处理等方面的内容。
一、命名规范1.包名规范包名应该全小写,连接符可以使用小写字母和下划线,不推荐使用数字。
包名应该能够清晰地表达包所包含的内容,不要使用太长或者太短的包名。
2.类名规范类名应该采用驼峰命名法,首字母大写,类名应该能够清晰地表达类的用途,不要使用太长或者太短的类名。
如果类名由多个单词组成,应该遵循每个单词首字母大写的命名规范。
3.接口名规范接口名应该采用驼峰命名法,首字母大写,接口名应该能够清晰地表达接口的用途,不要使用太长或者太短的接口名。
如果接口名由多个单词组成,应该遵循每个单词首字母大写的命名规范。
4.变量名规范变量名应该采用驼峰命名法,首字母小写,变量名应该能够清晰地表达变量的用途,不要使用太长或者太短的变量名。
如果变量名由多个单词组成,应该遵循每个单词首字母小写的命名规范。
5.常量名规范常量名应该全大写,单词之间使用下划线分隔,常量名应该能够清晰地表达常量的用途,不要使用太长或者太短的常量名。
6.方法名规范方法名应该采用驼峰命名法,首字母小写,方法名应该能够清晰地表达方法的用途,不要使用太长或者太短的方法名。
如果方法名由多个单词组成,应该遵循每个单词首字母小写的命名规范。
二、代码风格1.缩进和空格缩进使用4个空格,不使用tab键。
在操作符前后使用空格,增强代码的可读性。
2.大括号的使用在类定义、方法定义、控制结构等的语句块后面使用大括号,增强代码的可读性。
3.代码行长度每行代码的长度不要超过80个字符,超过80个字符的代码应该使用换行符进行分割。
4.引号的使用字符串常量应该使用双引号,字符常量应该使用单引号。
java 注释标准

java 注释标准在Java开发中,注释被广泛应用于代码的编写与维护过程中。
通过注释,开发人员可以为自己的代码添加解释说明,方便其他开发人员理解和使用代码。
本文将介绍Java中常用的注释标准,以及它们的使用方法与注意事项。
一、单行注释单行注释以"//"开头,用于对单行代码进行解释说明。
它可以出现在代码的任何位置,对该行代码进行注释,不会影响代码的执行。
例如:```javaint x = 10; // 定义一个整型变量x,初始值为10二、多行注释多行注释以"/*"开头,以"*/"结尾,用于对多行代码进行注释。
多行注释常用于对函数、类或一段代码的功能进行描述。
例如:```java/** 计算两个整数的和* @param a 整数1* @param b 整数2* @return 两个整数的和*/public int add(int a, int b) {return a + b;}三、文档注释文档注释以"/**"开头,以"*/"结尾,用于对类、接口、方法、字段等进行详细的描述。
文档注释是Java API文档的一部分,在生成API 文档时会被提取出来。
例如:```java/*** 学生类*/public class Student {/*** 学生姓名*/private String name;/*** 获取学生姓名* @return 学生姓名*/public String getName() {return name;}/*** 设置学生姓名* @param name 学生姓名*/public void setName(String name) { = name;}}四、注释的使用方法与注意事项1. 注释应该简洁明了,使用清晰的语言描述代码的功能、用途、参数、返回值等信息,以便其他开发人员理解和使用。
2. 注释应该与代码保持同步更新,避免注释与代码不一致的情况发生。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments 节点就是所有需设置注释的元素啦。
现就每一个元素逐一介绍:文件(Files)注释标签:/*** @Project: ${project_name}* @Title: ${file_name}* @Package ${package_name}* @Description: ${todo}* @author jeffshaw jeff_chon@* @date ${date} ${time}* @Copyright: ${year} Inc. All rights reserved.* @version V1.0*/类(Types)注释标签(类的注释):/*** @ClassName: ${type_name}* @Description: ${todo}* @author jeffshaw jeff_chon@* @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}*/简单模板例1:<?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 jeffshaw email:jeff_chon@* @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 jeffshaw email:jeff_chon@* @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:<?xml version="1.0" encoding="UTF-8"?><templates><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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: jeffwhaw email:jeff_chon@* @version: ${date} ${time}*/</template><templateautoinsert="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>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><templateautoinsert="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><templateautoinsert="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}*/<templateautoinsert="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><templateautoinsert="false"context="typecomment_context"deleted="false"description="Comment for created types"enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment"name="typecomment">/*** 此类描述的是:* @author: jeffshaw email:jeff_chon@* @version: ${date} ${time}*/</template></templates><?xml version="1.0" encoding="UTF-8"?><templates><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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: jeffshaw email:jeff_chon@* @version: ${date} ${time}*/</template><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="false"context="typecomment_context"deleted="false"description="Comment for created types"enabled="true"id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/*** 此类描述的是:* @author: jeffshaw email:jeff_chon@* @version: ${date} ${time}*/</template></templates>。