包含java代码注释率20%的词条

java工作中良好的代码注释习惯是什么

注释是为了方便自己或代码维护方更容易地读懂代码的用处。

一、背景 

1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？ 

2、怎么样避免我们的注释冗长而且凌乱不堪呢？ 

3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？ 

二、意义 

程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。 

三、注释的原则 

1、 注释形式统一 

在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。 

2、 注释的简洁 

内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。 

3、 注释的一致性 

在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。 

4、 注释的位置 

保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。 

5、 注释的数量 

注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。 

6、删除无用注释 

在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。 

7、 复杂的注释 

如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。 

8、 多余的注释 

描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释，避免多余的或不适当的注释出现。 

9、必加的注释 

典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。 

10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不 

会增加可执行文件的大小。 

四、JAVA注释技巧 

1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区 

别，并协调美观。 

2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的 

结束处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能 

写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。 

3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时， 

这样做会使注释很明显且容易被找到。 

4、不允许给块注释的周围加上外框。这样看起来可能很漂亮，但是难于维护。 

5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80 

字(800×600) 。 

6、Java编辑器（IDE）注释快捷方式。Ctrl+/ 注释当前行,再按则取消注释。 

7、对于多行代码的注释，尽量不采用“/*......*/”，而采用多行“//”注释， 

这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*......*/”。 

8、注释作为代码切换开关，用于临时测试屏蔽某些代码。

相关问答

Q1: java源程序的注释量必须在多少以上？

一般编程在1/4~1/3就可以了java代码注释率20%，其实编程的时候不单要关注注释的量java代码注释率20%，还要写的清晰、明了。注释的多少不是主要的java代码注释率20%，关键是能让别人看的时候能看明白。

另外在命名是也要特别注意，命名能都充分表现你的变量、方法、类的含义，这样也能起到注释的作用。

还有就是类、方法不能过大，方法十几行也就差不多了，太多可读性就比较差了。

Q2: 代码注释率占比20%合适

一般占 30%-40%

也不是这样确定java代码注释率20%，

首先是要在程序的开头写上这段代码的作用java代码注释率20%，或者自己为什么要写着一段代码

逻辑性很强的地方加上注释，使读者不用在头脑中仿真代码的运行过程

比如在 if 语句 for 语句，要是用到了一些比较复杂的算法，还要写的更清晰一些

祝你学习愉快

一般占 30%-40 也不是这样确定，首先是要在程序的开头写上这段代码的作用，或者自己为什么要写着一段代码 逻辑性很强的地方加上注释，使读者不用在头脑中仿真代码的运行过程 比如在 if 语句 for 语句，要是用到了一些...注释不重要，所有变量和方法注释，还有一些关键方法解释说明一下就够了 重要的是清晰的架构，文档 类图 你只要能让下一个拿到你代码的人看看文档就明白怎么回事就ok

求一份软件测试的报告,大体上要写什么,格式怎么样的。求救。我做的是... —— 2 引用文档《XX软件需求规格说明》《XX软件设计说明》《XX系统接口协议》3 测试概述3.1被测软件的基本概况使用的编程语言:XXX 汇编语言程序行数:1590子程序个数:11单行注释行数:669注释率:约为42%3.1.1. 测试小结本次测试对XX软件进...

软件测试报告怎么写 —— 2 引用文档《XX软件需求规格说明》《XX软件设计说明》《XX系统接口协议》3 测试概述3.1被测软件的基本概况使用的编程语言:XXX 汇编语言程序行数:1590子程序个数:11单行注释行数:669注释率:约为42%3.1.1. 测试小结本次测试对XX软件进...

Q3: 代码设计时应遵循哪些原则

1提高编码质量，代码可读性和可维护性。

2代码编写规范

2.1删除所有无用代码

2.2必须给代码添加注释，一个类的注释字数不得小于代码的百分之20%

2.3建议遵循30秒原则。如果另一个程序员无法在三十秒内无法知道你的函数在做什么，如何做以及为什么要这样做，那么说明你的代码是难于维护的，需要得到提高。

2.4一个函数的代码长度不允许超过100行，超过一百行的函数建议在不破坏原子性的基础上进行拆分。

2.5变量都应在方法或者类的头部集中定义

2.6保证一行代码只做一件事

2.7使用括号来控制操作符的运算顺序，以免使用java默认的操作符优先级顺序。

2.8代码格式化：对代码进行格式化，再进行提交。

2.9接口不允许没有方法或者变量的声明

3.命名规范

3.1各种标识符的命名要使用有实际意义的英文单词或者英文单词缩写，缩写词及英文单词要收录在项目的简写词汇表中。切忌使用阿拉伯数字和拼音进行命名。

3.2类名：首字母大写，每个单词首字母都需要大写。

3.3方法名：首字母小写，其余单词首字母都需大写。

3.4全局变量，和常量名称要求全部字母大写。

3.5参数名称与局部变量基本相同，区别在于参数名称需要加上冠词a，an或者在单词结尾以s结束。

4.注释规范

4.1注释需要注意的事项：

★注释应该用中文清晰表达意思，应该是程序看起来更清晰，更容易理解

★注释要尽量简明，避免装饰性的注释。

★注释不但要说明做什么，还应当说明为什么要这样做。最好先写注释表明要做什么，再进行编码。

4.2类的注释

★类的用途，目的。包括其他人感兴趣的介绍。

★已知bug,当然最好是修改好所有的错误，但有时可能暂时没有办法修改，或者没有时间修改。

★开发和维护该类的历史列表，记录每一次修改的作者，日期，修改的内容。

★列举类的各种稳定状态，说明调用成员函数使类的状态产生的变迁(可选)。

★同步问题（可选）

★对主要的算法必须加以说明，主要流程必须给予引导性说明

标准格式：

如果对已经版本话的类进行了修改，需要按照如下格式为每一次修改附加修改历史记录：

//修改人+修改日期

//修改说明范例：

//李四2010/07/02

//添加错误数据修改后继续批量保存的处理函数saveBatch(

@Bind(key="itemParams",defaultValue="")StringitemParams,

@Bind(key="pid",defaultValue="")Stringpid)。

//王小二2010/07/02

4.3接口注释：

★接口的注释风格基本与类的注释风格相同；

★在别人使用接口之前，必须了解接口所包含的概念。检验一个接口是否应该定义的简单方法是：你是否能★够容易的描述接口的用途；

★接口如何应当和不应当被使用。开发者需要知道该接口如何被使用，也希望知道该接口不能被怎样使用。

4.4函数的注释

★函数头注释必须包括：函数执行了什么功能，为什么要这样处理；函数处理过程中对对象的哪些属性

★可能进行更改；函数执行前后，对象的状态；

★比较、循环等控制结构加注释（可选）；

★在代码的功能并非一目了然的情况下，应当说明为什么要这样做；

★局部变量必须加注释；

★复杂难写的代码必须加注释；

4.5类属性的注释:

★描述域的用途。使别人知道如何去使用它；

★对于有着复杂事物规则的域，可以加入范例来说明。有时候一个简单的小例子，抵的上千言万语；

关于java代码注释率20%和的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。