什么是Java注释?代码注释有哪些规范?

阳光 2021-05-10 18:13:20 java常见问答 3434

Java注释是程序代码可维护性的重要环节之一,有了Java注释能够方便与程序员的交流,提高团队开发合作效率,那什么是Java注释?下面来我们就来给大家讲解一下这方面的内容。

Java注释其实就是对一些程序进行解释,除了自己方便阅读,更为别人更好理解自己的程序,所以我们需要进行一些注释,可以是编程思路或者是程序的作用,总而言之就是方便自己他人更好的阅读。

代码注释有哪些规范?

一、原则:

1、注释形式统一

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

2、注释内容准确简洁

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

二、注释条件:

1、基本注释(必须加)

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

(b) 构造函数的注释;

(c) 方法的注释;

(d) 全局变量的注释;

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

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

2、特殊必加注释(必须加)

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

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

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

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

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

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

其实注释就是对代码的解释和说明,让人们能够更加轻松地了解代码。提高程序代码的可读性,仿版日后与程序员的交流,最后大家如果想要了解更多java入门知识,敬请关注奇Q工具网。

推荐阅读:

java入门从哪里开始学?java入门顺序

json数组怎么拼接?json数据如何解析?

java怎么做大文件包的读写?Java如何读取大文件?