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. 注释应该与代码保持同步更新，避免注释与代码不一致的情况发生。
代码标准
Java开发中所要遵守的编码规范大体上有如下7点。
命名规范、注释规范、缩进排版规范、文件名规范、声明规范、语句规范以及编程规范。
1.命名规范（1）所有的标示符都只能用ASCⅡ字母（A-Z或a-z）、数字（0-9）和下划线“_”。
（2）一个唯一包名的前缀总是全部小写的字母。
例如：（3）类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。
例如：Neeke。
（4）接口的大小写规则与类名相似：例如：Neeke。
（5）方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
例如：setNeekeName(String neekeName)。
（6）变量名第一个字母小写，任何中间单词的首字母大写。
变量名应简短且可以顾名思义，易于记忆。
例如：neekeName、neekeAddress。
避免单个字符的变量名，除非是一次性的临时变量。
（7）常量的声明应该全部大写，每个单词之间用“_”连接。
例如：final String WWW_INEEKE_CN = "ww ";2.注释规范（1）注释尽可能使用“//”；对于所有的javadoc的注释则使用“”；而临时对代码块进行注释尽量使用“”。
（2）所有的源文件都应该在开头有一个注释，其中列出文件名、日期和类的功能概述。
（3）每个方法必须添加文档注释（类的main()方法除外）。
（4）每个属性必须添加注释。
（5）代码中至少包含15%的注释。
（6）注释使用中文。
3.缩进排版规范（1）避免一行的长度超过60个字符。
（2）使用Eclipse的源代码的格式化功能完成代码的缩进排版。
4.文件名规范（1）一个Java源文件只能存储一个Java类。
（2）文件名与Java类名相同。
（3）一个类文件的代码行不超过200行。
5.声明规范（1）一行声明一个变量。
（2）不要将不同类型变量的声明放在同一行。
（3）只在代码块的开始处声明变量。
javaDoc注释规范
javaDoc注释规范Javadoc虽然是Sun公司为Java⽂档⾃动⽣成设计的，可以从程序源代码中抽取类、⽅法、成员等注释形成⼀个和源代码配套的API帮助⽂档。
但是Javadoc的注释也符合C的注释格式，⽽且doxyen也⽀持该种风格的注释。
官⽅⽂档：维基百科：Javadoc 的注释结构和 C 类似。
都以/* 注释 */这种结构。
Javadoc 的内容很多，先学习⼀下 Overview注释，类注释和⽅法注释，其他的以后再学。
先贴出⼏段 Java 的⽰例代码。
概述:/*** @author Firstname Lastname <address @ >* @version 2010.0331 (E.g. ISO 8601 YYYY.MMDD)* @since 1.6 (The Java version used)*/public class Test {// class body}类:/*** A class representing a window on the screen.* For example:* <pre>* Window win = new Window(parent);* win.show();* </pre>** @author Sami Shaio* @version %I%, %G%* @see java.awt.BaseWindow* @see java.awt.Button*/class Window extends BaseWindow {...}字段/变量/*** The X-coordinate of the component.** @see #getLocation()*/int x = 1263732;/*** The horizontal distances of point.*/public int x;⽅法:/*** Returns the character at the specified index. An index* ranges from <code>0</code> to <code>length() - 1</code>.** @param index the index of the desired character.* @return the desired character.* @exception StringIndexOutOfRangeException* if the index is not in the range <code>0</code>* to <code>length()-1</code>.* @see ng.Character#charValue()*/public char charAt(int index) {...}/*** Validates a chess move.** @param theFromFile file from which a piece is being moved* @param theFromRank rank from which a piece is being moved* @param theToFile file to which a piece is being moved* @param theToRank rank to which a piece is being moved* @return true if the move is valid, otherwise false*/boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank) {// ...body}/*** Moves a chess piece.** @see java.math.RoundingMode*/void doMove(int theFromFile, int theFromRank, int theToFile, int theToRank) {// ...body}其实这些注释形式都差不多，主要是 tag 不同下⾯介绍⼀下 tag 及含义。
Java编程规范(10页)免费下载.pdf
程序注释
程序注释有四种格式：块注释格式，单行注释，跟随注释，行尾注释
¾ 块注释格式 块注释主要用于描述：文件、方法、数据结构和算法。一般在文件或者方法定义的
之前使用。也可以用在方法定义里面，如果块注释放在函数或者方法定义里，它必须与 它所描述的代码具有相同的缩进形式。
块注释应该用一个空行开头，以便于代码部分区分开来。 块注释举例：
会打字、5分钟快速自助建网站易启建站网免费提供建站平台，商业网站1年仅60元
简单语句
每行最多包含一个语句。
例如：
argv++;
// 正确
argc++;
// 正确
argv++; argc--; // 错误，应该避免这样写
组合语句
组合语句使用大括号括起来的一串语句。
1. 大括号中的语句比组合语句多一级缩进。
命名规则为： com.sinosoft.系统名[.模块名].xxx.xxx 具体参错误！未找到引用源。
包命名举例： com.sinosoft.platform.bl.facade com.sinosoft.platform.dto.domain
类命名规范 类名应该是名词，并且是大小写混合的。首字母要大写。尽量保证类名简单并且描
}
¾ 行尾注释 注释标记“//”能够注释一行或者该行由“//”开始直到行尾的部分。行尾注释不
能用在多行文本注释中。但它可以将多行代码注释掉。这三种注释方法举例如下。
if (foo > 1) {
// Do a double-flip.
...
}
else{
return false;
// Explain why here.
javadoc注释规范
javadoc注释规范javadoc做注释一. Java 文档// 注释一行/* ...... */ 注释若干行/** ...... */ 注释若干行，并写入 javadoc 文档通常这种注释的多行写法如下：/*** .........* .........*/javadoc -d 文档存放目录 -author -version 源文件名.java这条命令编译一个名为“源文件名.java”的 java 源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中 index.html 就是文档的首页。
-author 和 -version 两个选项可以省略。
二. 文档注释的格式1. 文档和文档注释的格式化生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入 <br>，如果要分段，就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。
如/*** This is first line. <br>***** This is second line. <br>This is third line.*/2. 文档注释的三部分先举例如下/*** show 方法的简述.* <p>show 方法的详细说明第一行<br>* show 方法的详细说明第二行* @param b true 表示显示，false 表示隐藏* @return 没有返回值*/public void show(boolean b) {frame.show(b);}第一部分是简述。
文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。
Java项目命名规范
Java项目命名规范一、命名规范1、项目名全部小写2、包名全部小写3、类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。
如：public class MyFirstClass{}4、变量名、方法名首字母小写，如果名称由多个单词组成，每个单词的首字母都要大写。
如：int index=0;public void toString(){}5、常量名全部大写如：public static final String GAME_COLOR=”RED”;6、所有命名规则必须遵循以下规则：1)、名称只能由字母、数字、下划线、$符号组成2)、不能以数字开头3)、名称不能使用JAVA中的关键字。
4)、坚决不允许出现中文及拼音命名。
二、注释规范1、类注释在每个类前面必须加上类注释，注释模板如下：/*** Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.* FileName: Test.java* 类的详细说明** @author 类创建者姓名* @Date 创建日期* @version 1.00*/2、属性注释在每个属性前面必须加上属性注释，注释模板如下：/** 提示信息*/private String strMsg = null;3、方法注释在每个方法前面必须加上方法注释，注释模板如下：/*** 类方法的详细使用说明** @param 参数1 参数1的使用说明* @return 返回结果的说明* @throws 异常类型.错误代码注明从此类方法中抛出异常的说明*/4、构造方法注释在每个构造方法前面必须加上注释，注释模板如下：/*** 构造方法的详细使用说明** @param 参数1 参数1的使用说明* @throws 异常类型.错误代码注明从此类方法中抛出异常的说明*/5、方法内部注释在方法内部使用单行或者多行注释，该注释根据实际情况添加。
java 标准的方法注释模板
java 标准的方法注释模板全文共四篇示例，供读者参考第一篇示例：在Java编程过程中，良好的代码注释是至关重要的。
它不仅能够帮助其他开发人员理解你的代码，还可以让你自己在日后回顾代码时更容易理解和修改。
对于方法的注释尤为重要，因为方法是代码的基本组成部分，它完成特定的功能并可以被其他代码调用。
为了帮助开发人员编写规范的方法注释，可以制定一份Java标准的方法注释模板。
这份模板应当包含以下几个方面的内容，以确保注释信息的完整性和易读性：1. 方法的作用和功能描述：在方法注释的开头部分，应当简要描述该方法的作用和功能。
这样其他开发人员就能够清楚地了解该方法的用途，从而更好地使用或修改该方法。
2. 输入参数说明：列出该方法接收的所有参数，并对每个参数进行详细的说明。
包括参数的名称、类型、作用以及可能的取值范围等信息。
这样可以帮助其他开发人员正确地传入参数并理解参数的含义。
3. 返回值说明：说明该方法的返回值类型以及可能的返回值。
还可以说明在什么情况下会返回特定的数值或对象。
这对开发人员了解方法的返回结果非常有帮助。
4. 异常处理说明：如果该方法会抛出异常，应当在注释中明确列出可能会发生的异常类型以及每种异常的出现条件。
这能够帮助其他开发人员处理异常情况或者进行适当的异常捕获和处理。
5. 使用示例：还可以在注释中提供一个简单的使用示例，演示该方法如何调用和使用。
这样其他开发人员可以更直观地了解该方法的使用方法。
通过以上几点内容的规范注释，可以使方法注释更加清晰、易读，并且具有一致性。
这样不仅可以方便其他开发人员理解和使用你的代码，还可以提高代码的可维护性和可读性。
注释是良好编程实践的重要组成部分，能够提高代码的质量和可维护性。
编写规范的方法注释模板是一个好的开始，可以使代码更易于理解和维护。
希望上述的方法注释模板能够帮助Java开发人员编写更规范、更易读的代码注释。
第二篇示例：Java是一种流行的编程语言，具有强大的灵活性和可扩展性。
java编码规范_缩进和注释
java编码规范_缩进和注释1. 缩进排版(Indentation)4个空格常被作为缩进排版的⼀个单位。
缩进的确切解释并未详细指定(空格 vs. 制表符)。
⼀个制表符等于n个空格(视具体的编辑器⽽定，Eclipse默认⼀个制表符为4个字符)。
3.1 ⾏长度(Line Length)尽量避免⼀⾏的长度超过80个字符，因为很多终端和⼯具不能很好处理之。
注意：鉴于Eclipse开发⼯具⼯作区的左侧和右侧都被⾮代码编辑器所占据，因此建议每⾏的代码长度不要超过70个字符。
3.2 换⾏(Wrapping Lines)当⼀个表达式⽆法容纳在⼀⾏内时，可以依据如下⼀般规则断开之：·在⼀个逗号后⾯断开；·在⼀个操作符前⾯断开；·宁可选择较⾼级别(higher-level)的断开，⽽⾮较低级别(lower-level)的断开；·新的⼀⾏应该与上⼀⾏同⼀级别表达式的开头处对齐。
·如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格，或者以调⽤参数的⾸个括号对齐，或者以⾸个运对齐。
以下是断开⽅法调⽤的⼀些例⼦：someMethod(longExpression1, longExpression2, longExpression3,longExpression4,longExpression5);var = someMethod1(longExpression1,someMethod2(longExpression2, longExpression3));以下是两个断开算术表达式的例⼦。
前者更好，因为断开处位于括号表达式的外边，这是个较⾼级别的断开。
longName1 = longName2 * ( longName3 + longName4 - longName5 ) +4 * longname6; //推荐使⽤longName1 = longName2 * ( longName3 + longName4- longName5 ) + 4 * longname6; //应避免这样使⽤以下是两个缩进⽅法声明的例⼦。
java语言三种注释的语法格式以及用途
java语言三种注释的语法格式以及用途
Java语言中有三种注释方式，它们分别是：
1. 单行注释：
语法格式：使用两个斜杠（//）开始注释，后面跟随注释内容。
示例：
```java
// 这是一个单行注释
int x = 10; // 将 x 的值设为 10
```
用途：用于在一行中对代码进行简要说明，帮助开发者理解代码的功能和意图。
2. 多行注释：
语法格式：使用 / 开始注释，使用 / 结束注释。
示例：
```java
/
这是一个多行注释，可以跨越多行。
在这里说明代码的功能和作用。
/
int y = 20; / 将 y 的值设为 20 /
```
用途：用于对代码块进行详细说明，可以跨越多行。
通常用于解释复杂的代码逻辑或提供额外的信息。
3. Javadoc 注释：
语法格式：使用 / 开始注释，使用 / 结束注释。
这种注释方式也被称为Javadoc 注释。
示例：
```java
/
这是一个 Javadoc 注释，用于描述类的功能和属性。
在这里编写对类的描述信息。
/
public class MyClass { / ... / }
```
用途：用于生成 Javadoc 文档。
通过 Javadoc 工具，可以将注释解析为HTML 格式的文档，提供给开发人员参考和查阅。
JAVA编码规范
Java编码规范一、命名规范1. 类名首字母应该大写。
属性（成员变量）、方法、对象变量以及所有标识符（如形式参数、实际参数、局部变量）的首字母应小写，其中包含的所有单词都应紧靠在一起，而且大写中间单词的首字母。
例如：类名：ThisIsAClassName 属性或方法名：thisIsMethodOrFieldName对象变量：thisIsAClassVariable2. Java 包（Package）属于一种特殊情况，它们全都是小写字母，即便中间的单词亦是如此。
对于全局包，将你的Internet 域名反转并接上包名，例如：pany.package另外，package 行要在import 行之前，import 中标准的包名要在本地的包名之前，而且按照字母顺序排列。
如果import 行中包含了同一个包中的不同子目录，则应该用* 来处理。
例如package .stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里java.io.* 是用来代替InputStream and OutputStream 的。
3. 接口（Interface）：采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。
习惯上，名字后面加上后缀able，ible 或者er。
例如：Contactable，Prompter。
4. 组件（Component）使用完整的英文描述来说明组件的用途，末端应接上组件类型。
例如：okButton，customerList，fileMenu。
5. 类中常用方法的命名：类的获取方法（一般具有返回值）一般要求被方法名使用被访问字段名，前面加上前缀get，如getFirstName(), getLastName()。
类的布尔型的判断方法一般要求方法名使用单词is 做前缀，如isPersistent(),isString()。
java文件头注释格式
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 <a href="xiuzhong.li@">Jerryli</a>* @version 1.0**/注意选择自动添加注释养成一个规范的习惯是最好的。
选菜单windows-->preferenceJava-->Code Style-->Code Templatescode-->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}* @Description:${todo}(这里用一句话描述这个类的作用)* @author: Android_Robot* @date: ${date} ${time}** ${tags}*/（3）字段(Fields)注释标签：/*** @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */（4）构造函数标签：/*** @Title: ${enclosing_type}* @Description: ${todo}(这里用一句话描述这个方法的作用)* @param: ${tags}* @throws*/（5）方法(Methods)标签：/*** @Title: ${enclosing_method}* @Description: ${todo}(这里用一句话描述这个方法的作用)* @param: ${tags}* @return: ${return_type}* @throws*/（6）覆盖方法(Overriding Methods)标签:/*** <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags}* ${see_to_overridden}*/（7）代表方法(Delegate Methods)标签：/*** ${tags}* ${see_to_target}*/（8）getter方法标签：/*** @Title: ${enclosing_method} <BR>* @Description: please write your description <BR> * @return: ${field_type} <BR>*/（9）setter方法标签：/*** @Title: ${enclosing_method} <BR>* @Description: please write your description <BR> * @return: ${field_type} <BR>*/ren。
java注释书写规范
Java注释书写规范Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。
也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
注释注释是指程序中的解释性文字。
这些文字供程序的阅读者查看，编译器将不对其进行编译。
注释能够帮助读者理解程序，并为后续进行测试和维护提供明确的指导信息。
注释要简明，恰到好处，没有注释的代码是糟糕编程习惯的显著标志。
基本原则注释应该增加代码的清晰度。
代码注释的目的是要使代码更易于被其他开发人员等理解。
避免使用装饰性内容。
保持注释的简洁。
注释信息不仅要包括代码的功能，还应给出原因。
不要为注释而注释。
除变量定义等较短语句的注释可用行尾注释外，其他注释应当避免使用行尾注释。
从用途上分，注释可以分为序言性注释和功能性注释。
序言性注释：通称位于程序或者模块的开始部分。
它给出了程序或模块的整体说明，这种描述不包括程序的执行过程细节。
功能性注释：一般嵌入在源程序体之中。
其主要描述某个语句或程序段做什么，执行该语句或程序段会怎样，不是解释怎么做。
只有复杂的执行细节才需要嵌入注释，描述其实现方法。
根据注释符的不同，在java程序中有三种注释。
行注释符“/ / ”编译器会认为以“/ /”开头的字符直至本行末尾都是注释，所以又称行注释。
它一般用于对某条语句或某个变量的注释，以及一些文字不多的注释。
块注释符“/ * ”和“*/ ”“/ * ”和“*/ ”是成对出现的，它们之间的文字都是注释。
这些注释可以分成多行不必再添加行注释符。
文档注释“/ ** ”和“*/ ”文档注释也是一种块注释，它是用来生成帮助文档的。
当程序员编写完程序以后，可以通过JDK提供的javadoc命令，生成所编程序的API文档，而文档中的内容主要就是从文档注释中提取的。
该API文档以HTML文件的形式出现，与java帮助文档的风格及形式完全一致。
- 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>。