Java代码注释规范(动力节点整理)

 更新时间:2017年03月29日 16:41:04   投稿:mrr  
代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。下面通过本文说一下我们在日常开发中使用的代码注释规范

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

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. 类(接口)注释

例如:

/**
* 类的描述
* @author Administrator
* @Time 2016-11-14:49:01
*
*/
public classTest extends Button {
 ……
}

2.   构造方法注释

例如:

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

3.   方法注释

例如

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

4.   全局变量注释

例如:

public final class String
 implements Java.io.Serializable, Comparable<String>,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
……
}

5.   字段/属性注释

例如:

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> EmailList;
……
}

其实规范是自己订的,只要团队中大家都统一遵守,统一规范,就会取得好的效果,希望对平时不加注释的朋友有点帮助。

以上所述是小编给大家介绍的Java代码注释规范(动力节点整理),希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!

相关文章

  • java  工厂方法详解及实例代码

    java 工厂方法详解及实例代码

    这篇文章主要介绍了java 工厂方法详解及实例代码的相关资料,需要的朋友可以参考下
    2017-01-01
  • Java实现自定义LinkedList类的示例代码

    Java实现自定义LinkedList类的示例代码

    LinkedList类跟ArrayList类不同,它通过指针以及结点的操作对链表进行增删改查。本文就来和大家分享下Java如何为实现自定义LinkedList类,需要的可以参考一下
    2022-08-08
  • 通过实例解析Java类初始化和实例初始化

    通过实例解析Java类初始化和实例初始化

    这篇文章主要介绍了通过实例解析Java类初始化和实例初始化,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-11-11
  • Mybatis的mapper标签 namespace属性用法说明

    Mybatis的mapper标签 namespace属性用法说明

    这篇文章主要介绍了Mybatis的mapper标签 namespace属性用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Java面试之高级特性基础总结

    Java面试之高级特性基础总结

    这篇文章主要为大家详细介绍了10个Java高级特性基础相关的问题,也是大家面试中常常会遇到的问题。文中的示例代讲解详细,感兴趣的可以了解一下
    2023-01-01
  • Mybatis Interceptor 拦截器的实现

    Mybatis Interceptor 拦截器的实现

    这篇文章主要介绍了Mybatis Interceptor 拦截器的实现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12
  • springboot下使用shiro自定义filter的个人经验分享

    springboot下使用shiro自定义filter的个人经验分享

    这篇文章主要介绍了springboot下使用shiro自定义filter的个人经验,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • Spring异常实现统一处理的方法

    Spring异常实现统一处理的方法

    这篇文章主要介绍了Spring异常实现统一处理的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-12-12
  • java实现双色球彩票游戏

    java实现双色球彩票游戏

    这篇文章主要为大家详细介绍了java实现双色球彩票游戏,超级简单的逻辑,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-06-06
  • 通过Java实现在Word中创建可填充表单

    通过Java实现在Word中创建可填充表单

    这篇文章主要为大家详细介绍了如何通过Java代码,以编程方式在Word中创建可填充表单,文中的示例代码讲解详细,感兴趣的小伙伴可以了解一下
    2023-03-03

最新评论