JAVA注释技巧及实例说明

《JAVA注释技巧及实例说明》由会员分享，可在线阅读，更多相关《JAVA注释技巧及实例说明（5页珍藏版）》请在金锄头文库上搜索。

1、JAVA 注释技巧及实例说明注释技巧及实例说明JAVA 注释技巧注释技巧1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区 别，并协调美观。2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的 结束处加注释（在闭合的右花括号后注释该闭合所对应的起点） ，注释不能 写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时， 这样做会使注释很明显且容易被找到。4、不允许给块注释的周围加上外框。这样看起来可能很漂亮，但是难于维护。5、每行注释（连同代码）不要超过 120 个字（10

2、24768） ，最好不要超过 80 字（800600） 。6、Java 编辑器（IDE）注释快捷方式。Ctrl+/ 注释当前行，再按则取消注释。7、对于多行代码的注释，尽量不采用“/*.。.。.*/”，而采用多行“/”注释， 这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*.。.。.*/”。8、注释作为代码切换开关，用于临时测试屏蔽某些代码。 例一： /*/ codeSegement1; /*/ 改动第一行就成了： /*/ codeSegement1; /*/ 例二： /-第一段有效，第二段被注释 /*/ codeSegement1; /*/ codeSegement2; /*/ 只需删除

3、第一行的/就可以变成： /-第一段被注释，第二段有效 /*/ codeSegement1; /*/ codeSegement2; /*/五、JAVA 注释方法及格式1、单行（single-line）-短注释：/ 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样 的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：/ 注释内容 行尾注释：尾端（trailing）-极短的注释，在代码行的行尾进行注释。一般与代码行后空 8（至少 4）个格，所有注释必须对齐。 注释格式

4、：代码 + 8（至少 4）个空格 + / 注释内容 2、块（block）-块注释：/*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描 述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适 的位置。这种域注释不会出现在 HTML 报告中。注释格式通常写成： /* * 注释内容 */ 3、文档注释：/*/ 注释若干行，并写入 javadoc 文档。每个文档注释都会被置于注释定界符 /*.。.。.*/之中，注释文档将用来生成 HTML 格式的代码报告，所以注释文 档必须书写在类、域、构造函数、方法，以及字段（field）定义之前。注释文档

5、由两部分 组成描述、块标记。注释文档的格式如下： /* * The doGet method of the servlet. * This method is called when a form has its tag value method * equals to get. * param request * the request send by the client to the server * param response * the response send by the server to the client * throws ServletException * if

6、an error occurred * throws IOException * if an error occurred */ public void doGet （HttpServletRequest request， HttpServletResponse response） throws ServletException， IOException doPost（request， response）; 前两行为描述，描述完毕后，由符号起头为块标记注释。更多有关文档注 释和 javadoc 的详细资料，参见 javadoc 的主页： http:/ 4、javadoc 注释标签语法 auth

7、or 对类的说明 标明开发该类模块的作者 version 对类的说明 标明该类模块的版本see 对类、属性、方法的说明 参考转向，也就是相关主题 param 对方法的说明 对方法中某参数的说明 return 对方法的说明 对方法返回值的说明 exception 对方法的说明 对方法可能抛出的异常进行说明JAVA 注释具体实现注释具体实现1、源文件注释源文件注释采用 /* */，在每个源文件的头部要有必要的注释信息，包括：文件 名；文件编号；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注 释模版： /* * 文 件 名 ： * CopyRright （c） 2008-xxxx：

8、 * 文件编号： * 创 建 人： * 日 期： * 修 改 人： * 日 期： * 描 述： * 版 本 号： */2、类（模块）注释：类（模块）注释采用 /* */，在每个类（模块）的头部要有必要的注释信息，包 括：工程名；类（模块）编号；命名空间；类可以运行的 JDK 版本；版本号；作者；创建 时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的 关系等，必要时还要有一些如特别的软硬件要求等说明） ；主要函数或过程清单及本类（模 块）历史修改记录等。 英文注释模版： /* * CopyRright （c）2008-xxxx： 展望软件 Forsoft * Pro

9、ject： 项目工程名 * Module ID： （模块）类编号，可以引用系统设计中的类编号 * Comments： 对此类的描述，可以引用系统设计中的描述 * JDK version used： JDK1.6 * Namespace： 命名空间 * Author： 作者中文名或拼音缩写 * Create Date： 创建日期，格式：YYYY-MM-DD * Modified By： 修改人中文名或拼音缩写 * Modified Date： 修改日期，格式：YYYY-MM-DD* Why 如果返回值就是输入参数，必须 * 用与输入参数的param 相同的描 述信息; 必要的时* 候注明特殊条件

10、写的返回值。 * 异 常：按照异常名字的字母顺序 * 创 建 人： * 日 期： * 修 改 人： * 日 期： */ 注释模版二： /* * FunName： getFirstSpell * Description ： 获取汉字拼音首字母的字符串， * 被生成百家姓函数调用 * param： str the String 是包含汉字的字符串 * return String：汉字返回拼音首字母字符串； * 英文字母返回对应的大写字母； * 其他非简体汉字返回 0； * Author： ghc * Create Date： 2008-07-02 */ 5、方法注释： 方法注释采用 /* */，对

11、于设置 （Set 方法 ） 与获取 （Get 方法 ） 成员的方法， 在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参 数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提 供宝贵线索。 6、方法内部注释： 控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分， 要尽可能的给出详细的注释。 7、 全局变量注释： 要有较详细的注释，包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事 项等的说明。 8、局部（中间）变量注释： 主要变量必须有注释，无特别意义的情况下可以不加注释。 9、实参/参数注释： 参数含义、及其它任何约束或前提条件。 10、字段/属性注释： 字段描述，属性说明。 11、常量：常量通常具有一定的实际意义，要定义相应说明。文章来源：java 视频 http:/www.leadfar.org/