JAVA代码注释规范.doc

JAVA代码注释规范 目录 JAVA代码注释规范 1 注释的原则 1 注释的简洁 1 注释的一致性 1 注释的位置 1 注释的数量 1 删除无用注释 2 复杂的注释 2 多余的注释 2 必加的注释 2 JAVA注释技巧 2 JAVA注释具体实现 4 源文件注释 4 类（模块）注释： 4 接口注释： 5 构造函数注释： 5 方法注释： 6 方法内部注释： 7 全局变量注释： 7 局部（中间）变量注释： 7 常量 7 p.s. 注释使用统一的注释文件 7 注释的原则?注释形式统一?在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同， 按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。? 注释的简洁?内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。? 注释的一致性?在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码， 在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建， 提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。? 注释的位置?保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。 避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。? 注释的数量?注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档， 程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。? 删除无用注释?在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。? 复杂的注释?如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。 尽管一般不应该为了使代码更简单便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。? 多余的注释?描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的， 也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释，避免多余的或不适当的注释出现。? 必加的注释?典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。 为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。? 注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不?会增加可执行文件的大小。? ? JAVA注释技巧? 1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区别，并协调美观。? ? 2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的?结束处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能? 写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。? ? 3、Java编辑器（IDE）注释快捷方式。Ctrl+/?注释当前行,再按则取消注释。 ? 4、注释作为代码切换开关，用于临时测试屏蔽某些代码 例一：? //*/? ???codeSegement1;? //*/? 改动第一行就成了：? /*/? ???codeSegement1;? //*/? ? 例二：? //----------------------第一段有效，第二段被注释? //*/? ???codeSegement1;? /*/? ???codeSegement2;? //*/? 只需删除第一行的/就可以变成：? //----------------------第一段被注释，第二段有效? /*/? ???codeSegement1;? /*/? ???codeSegement2;? //*/? ? JAVA注释具体实现? 源文件注释? 源文件注释采用?/**?……?*/，在每个源文件的头部要有必要的注释信息，包括：文件名；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注释模版：? /**? *?文?件?名?:? *?版权:? *?创?建?人：? *?日????期：? *?修?改?人：? *?日???期：? *?描???述：? *?版?本?号：? */? ? 类（模块）注释：? 类（模块）注释采用?/**?……?*/，在每个类（模块）的头部要有