Java代码注释规范(动力节点整理)
代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。下面说一下我们在日常开发中使用的代码注释规范，供大家参考下。
1、 注释形式统一
在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。
2、 注释内容准确简洁
内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。
注释条件：
1、基本注释
(a) 类（接口）的注释
(b) 构造函数的注释
(c) 方法的注释
(d) 全局变量的注释
(e) 字段/属性的注释
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。
2、特殊必加注释
(a) 典型算法必须有注释。
(b) 在代码不明晰处必须有注释。
(c) 在代码修改处加上修改标识的注释。
(d) 在循环和逻辑分支组成的代码中加注释。
(e) 为他人提供的接口必须加详细注释。
备注：此类注释格式暂无举例。具体的注释格式自行定义，要求注释内容准确简洁。
注释格式：
1、单行(single-line)注释：“//……”
2、块(block)注释：“/*……*/”
3、文档注释：“/**……*/”
4、javadoc注释标签语法
@author 对类的说明标明开发该类模块的作者
@version 对类的说明标明该类模块的版本
@see 对类、属性、方法的说明参考转向，也就是相关主题
@param 对方法的说明对方法中某参数的说明
@return 对方法的说明对方法返回值的说明
@exception 对方法的说明对方法可能抛出的异常进行说明
参考举例：
1. 类（接口）注释
例如：
/**
*类的描述
*@authorAdministrator
*@Time2016-11-14:49:01
*
*/
publicclassTestextendsButton{
……
}
2. 构造方法注释
例如:
publicclassTestextendsButton{
/**
*构造方法的描述
*@paramname
*按钮的上显示的文字
*/
publicTest(Stringname){
……
}
}
3. 方法注释
例如
publicclassTestextendsButton{
/**
*为按钮添加颜色
*@paramcolor
按钮的颜色
*@return
*@exception(方法有异常的话加)
*@authorAdministrator
*@Time2012-11-2015:02:29
*/
publicvoidaddColor(Stringcolor){
……
}
}
4. 全局变量注释
例如：
publicfinalclassString implementsJava.io.Serializable,Comparable,CharSequence { /**Thevalueisusedforcharacterstorage.*/ privatefinalcharvalue[]; /**Theoffsetisthefirstindexofthestoragethatisused.*/ privatefinalintoffset; /**ThecountisthenumberofcharactersintheString.*/ privatefinalintcount; /**Cachethehashcodeforthestring*/ privateinthash;//Defaultto0 …… }
5. 字段/属性注释
例如：
publicclassEmailBodyimplementsSerializable{
privateStringid;
privateStringsenderName;//发送人姓名
privateStringtitle;//不能超过120个中文字符
privateStringcontent;//邮件正文
privateStringattach;//附件，如果有的话
privateStringtotalCount;//总发送人数
privateStringsuccessCount;//成功发送的人数
privateIntegerisDelete;//0不删除1删除
privateDatecreateTime;//目前不支持定时所以创建后即刻发送
privateSetEmailList;
……
}
其实规范是自己订的，只要团队中大家都统一遵守，统一规范，就会取得好的效果，希望对平时不加注释的朋友有点帮助。
以上所述是小编给大家介绍的Java代码注释规范(动力节点整理)，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对毛票票网站的支持！