java代码注释规范

desdik 发布于2019-08-15 12:21 / 3345人阅读

摘要：下面说一下我们在诉求网二期开发中使用的代码注释规范，供大家参考下。在代码不明晰处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中加注释。

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

原则：

1、注释形式统一

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

2、注释内容准确简洁

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

注释条件：

1、基本注释（必须加）

(a) 类（接口）的注释

(b) 构造函数的注释

(d) 全局变量的注释

(e) 字段/属性的注释

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

2、特殊必加注释（必须加）

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

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

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

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

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

注释格式：

1、单行(single-line)注释：“//……”

2、块(block)注释：“/……/”

3、文档注释：“/*……/”

4、javadoc 注释标签语法

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

参考举例：

类（接口）注释

例如：

</>复制代码 
/**
* 类的描述
* @author Administrator
* @Time 2012-11-2014:49:01
*
*/
public classTest extends Button {
  ……
}

构造方法注释

例如:

</>复制代码 
public class Test extends Button {
  /**
   * 构造方法 的描述
   * @param name
   *       按钮的上显示的文字
   */
  public Test(String name){
     ……
  }
}

方法注释

例如

</>复制代码 
public class Test extends Button {
  /**
   * 为按钮添加颜色
   *@param color
         按钮的颜色
*@return
*@exception  (方法有异常的话加)
* @author Administrator
* @Time2012-11-20 15:02:29
   */
  public voidaddColor(String color){
     ……
  }
}

全局变量注释

例如：

</>复制代码 
public final class String
   implements java.io.Serializable, Comparable,CharSequence
{
   /** The value is used for characterstorage. */
   private final char value[];
   /** The offset is the first index of thestorage that is used. */
   private final int offset;
   /** The count is the number of charactersin the String. */
   private final int count;
   /** Cache the hash code for the string */
private int hash; // Default to 0
……
}

字段/属性注释

例如：

</>复制代码 
public class EmailBody implements Serializable{
   private String id;
   private String senderName;//发送人姓名
   private String title;//不能超过120个中文字符
   private String content;//邮件正文
   private String attach;//附件，如果有的话
   private String totalCount;//总发送人数
   private String successCount;//成功发送的人数
   private Integer isDelete;//0不删除 1删除
   private Date createTime;//目前不支持定时 所以创建后即刻发送
   privateSet EmailList;
……
}

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/67890.html

番外篇2-基本规范、注释、static关键字、import关键字

摘要：今日份重点命名规范注释关键字关键字总结命名规范规范的包名名字管理是所有编程语言都必须重视的一个问题。比如说百度，其域名为，那么其对应的应用的包名前缀就应该为。是谁这么大牌总结本文主要介绍了中的命名规范注解关键字关键字等内容。欢迎关注我的微信公众号，共同打牢Java的基础，向着远方进击 showImg(https://segmentfault.com/img/bVboaBO?w=129...

codecraft 2019-08-16 15:03 评论0 收藏0
乐字节Java变量与数据结构之一：Java编程规范、关键字和标识符

摘要：大家好，我是乐字节的小乐，这次要给大家带来的是变量与数据类型。本文是第一集编程规范，关键字与标识符。后面我们要写一个程序的过程。需求分析实现代码体现注释的作用解释说明程序，提高了代码的阅读性。可以帮助我们调试程序。大家好，我是乐字节的小乐，这次要给大家带来的是Java变量与数据类型。本文是第一集：Java编程规范，关键字与标识符。showImg(https://segmentfaul...

qianfeng 2019-08-16 18:27 评论0 收藏0
自己整理的java编程规范

摘要：努力避免硬编码。一个类的总体行数尽量控制在行左右不超过一千行。函数注释函数注释采用，在每个函数或者过程的前面要有必要的注释信息，包括函数或过程名称功能描述输入输出及返回值说明调用关系及被调用关系说明等。前言推荐Google的Java编码规范英文版： http://google-styleguide.googlecode.com/svn/trunk/javaguide.html 虽然...

yedf 2019-08-14 14:04 评论0 收藏0
JAVA代码规范

摘要：前言作为一名全干打字员，干活时经常会被要求使用各种各样的语言去实现各种各样的需求，来回切换起来写的代码就会或多或少有点不规范。今天我们以为例，讲讲在代码中，我们需要注意的某些规范。前言作为一名全干打字员，干活时经常会被要求使用各种各样的语言去实现各种各样的需求，来回切换起来写的代码就会或多或少有点不规范。今天我们以JAVA为例，讲讲在代码中，我们需要注意的某些规范。（本文标准依赖于...

GHOST_349178 2019-08-16 10:58 评论0 收藏0
升级 Java 编程规范的6个约定

摘要：对变量对象或者函数等进行命名时，选择能清晰表达其用途的名字。其实，测试方法名应该明确指出测试的内容与条件。和这种命名方式是时代的前朝遗物。使用自己的异常类型笔者又一次错误地认为这一开发习惯是业内的共识。作为 Java 开发人员，我们会遵循一系列的编码风格和开发习惯。习惯使然是一方面，另一方面，我们也从不停下脚步质疑这些习惯。一段时间以后，笔者养成了一些不同于常人的编码风格和开发习惯。...

taowen 2019-08-14 15:09 评论0 收藏0