Java中代码注释的规范有哪些

Java中代码注释的规范有哪些?很多新手对此不是很清楚,为了帮助大家解决这个难题,下面小编将为大家详细讲解,有这方面需求的人可以来学习下,希望你能有所收获。

代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一,所以我们不是为写注释而写注释。下面说一下我们在日常开发中使用的代码注释规范,供大家参考下。

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

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

<强> 1,基本注释

(a),,,类(接口)的注释

(b),,,构造函数的注释

(c),,,,方法的注释

(d),,,全局变量的注释

(e),,,字段/属性的注释

,备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或签证官对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。

<强> 2,特殊必加注释

(a),,,典型算法必须有注释。

(b),,,在代码不明晰处必须有注释。

(c),,,,在代码修改处加上修改标识的注释。

(d),,,在循环和逻辑分支组成的代码中加注释。

(e),,,为他人提供的接口必须加详细注释。

,备注:此类注释格式暂无举例。具体的注释格式自行定义,要求注释内容准确简洁。

1,单行(单行)注释:“//?/p>

2块(块)注释:“/*……*/?/p>

3,文档注释:“/* *……*/?/p>

4, javadoc注释标签语法

@author ,对类的说明标明开发该类模块的作者
@version ,对类的说明标明该类模块的版本
@see ,,,对类,属性,方法的说明参考转向,也就是相关主题
@param ,,对方法的说明对方法中某参数的说明
@return ,对方法的说明对方法返回值的说明
@exception 对方法的说明对方法可能抛出的异常进行说明

<强> 1只类(接口)注释

例如:

公共类测试扩展按钮{/* *
　　*构造方法的描述
　　* @param名字
　　*按钮的上显示的文字
　　*/公共测试(字符串名称){
　　……
　　}
　　}

公共类测试扩展按钮{/* *
　　*为按钮添加颜色
　　* @param颜色
　　按钮的颜色
　　* @return
　　* @exception(方法有异常的话加)
　　* @author管理员
　　* @Time2012-11-20 15:02:29
　　*/公共voidaddColor (String颜色){
　　……
　　}
　　}

公共类EmailBody实现Serializable {
　　私人字符串id;
　　私人字符串senderName;//发送人姓名
　　私人字符串标题;//不能超过120个中文字符
　　私人字符串内容;//邮件正文
　　私人字符串连接;//附件,如果有的话
　　私人字符串totalCount;//总发送人数
　　私人字符串successCount;//成功发送的人数
　　私人整数isDelete;//0不删除1删除
　　私人约会createTime;//目前不支持定时所以创建后即刻发送
　　privateSetEmailList;
　　……
　　}