Java注释规范整理

《Java注释规范整理》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、Java注释规范一、背景1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？2、怎么样避免我们的注释兀长而月.凌乱不堪呢？3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？二、意义程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件木身和软件开发人员而言尤为重要。并冃在流行的敏捷开发思想中己经提岀了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本，并且几乎没有任何一个软件，在其整个生命周期小，均由最初的开发人员来维护。好的注释规范可以改善软件的可

2、读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的捉高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。三、注释的原则1、注释形式统一在整个应用程序中，使用貝有一致的标点和结构的样式來构造注释。如果在其他项H组发现他们的注释规范与这份文档不同，按照他们的规范写代码,不耍试图在既成的规范系统屮引入新的规范。2、注释的简洁内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。3、注释的一致性在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，

3、在今天看來很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程小创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。4、注释的位置保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。5、注释的数量注释必不可少，但也不应过多，在实际的代码规范屮，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可

4、喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。6、删除无用注释在代码交付或部署发布Z前，必须删掉临时的或无关的注释，以避免在日后的维护工作屮产生混乱。7、复杂的注释如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽-切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单-便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。8、多余的注释描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码

5、本来就是清楚、一口了然的则不加注释，避免多余的或不适当的注释岀现。9、必加的注释典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队坏中c10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不会增加可执行文件的大小。四、JAVA注释技巧1、空行和空口字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区别，并协调美观。2、当代码比较特别是有多重嵌套吋，为了使层次清晰，应当在一些段落的结束处加注释（在闭合的右花括号后注释

6、该闭合所对应的起点），注释不能写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。4、不允许给块注释的周围加上外框。这样看起來可能很漂亮，但是难于维护。5、每行注释（连同代码）不要超过120个字（1024X768）,最好不要超过80字（800X600）o6、Java编辑器（IDE）注释快捷方式。Ctrl+/注释当前行，再按则取消注释。7、对于多行代码的注释，尽量不采用“/**/”，而采用多行“//”注释，这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/**

7、/”o8、注释作为代码切换开关，用于临吋测试屏蔽某些代码。例一：//*/codcScgcmcntl;//*/改动第一行就成了：/*/codeSegementl;//*/例二//第一段冇效，第二段被注释//*/codeSegementl;/*/codeSegement2;//*/只需删除第一行的/就可以变成：//第一段被注释，第二段有效/*/codeSegementl;/*/codeSegement2;//*/五、JAVA注释方法及格式1、单行(single-line)—短注释://单独行注释