Java代码注释规范详解
代码附有注释对程序开发者来说非常重要，随着技术的发展，在项目开发过程中，必须要求程序员写好代码注释，这样有利于代码后续的编写和使用。
基本的要求：
1、注释形式统一
在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。
2、注释内容准确简洁
内容要简单、明了、含义准确，防止注释的多义性，错误的注释不但无益反而有害。
3、基本注释（必须加）
(a) 类（接口）的注释
(b) 构造函数的注释
(c) 方法的注释
(d) 全局变量的注释
(e) 字段/属性的注
备注：简单的代码做简单注释，注释内容不大于10个字即可，另外，持久化对象或
VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。
4、特殊必加注释（必须加）
(a) 典型算法必须有注释。
(b) 在代码不明晰处必须有注释。
(c) 在代码修改处加上修改标识的注释。
(d) 在循环和逻辑分支组成的代码中加注释。
(e) 为他人提供的接口必须加详细注释。
备注：此类注释格式暂无举例。具体的注释格式自行定义，要求注释内容准确简洁。
5、注释格式：
1）、单行(single-line)注释：“//……”
2）、块(block)注释：“/*……*/”
3）、文档注释：“/**……*/”
4）、javadoc注释标签语法
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向，也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
6、例子：
/**
建立一个用于操作数组的工具类，其中包含这常见的对数组的操作的函数:最值。
@author 张三
@version v.
*/
public class ArrayTool{
/**
获取整形数组的最大值
@param arr 接收一个元素为int类型的数组
@return 该数组的最大的元素值
*/
public int getMax(int arr){
int Max = ;
return Max;
}
}
输入命令如下图：
然后在如下的目录下查看，最后点击 index.html：
以上内容给大家分享了Java代码注释规范，希望对大家有所帮助。
相关文章
本篇文章小编为大家介绍，java socket 详细介绍。需要的朋友参考下2013-04-04
Java创建数组、赋值的四种方式详解(声明+创建+初始化 )
数组是一种数据结构,用来存储同一类型值的集合一旦创建了数组,就不能再改变它的长度,下面这篇文章主要给大家介绍了关于Java创建数组、赋值的四种方式(声明+创建+初始化 )的相关资料,需要的朋友可以参考下2024-04-04
在Spring Boot中,配置文件中的${test.aa}等占位符的值可以通过系统属性或依赖的其他模块来获取,这意味着,可以通过JVM参数或者系统属性来指定这些值,例如,通过在启动命令中添加-Dtest.aa=your_value或在代码中通过2024-10-10
这篇文章主要给大家介绍了关于java日志门面之JCL和SLF4J的相关资料,在系统开发过程中日志框架的选择与更换是一大挑战,日志门面的概念,如JCL和SLF4J,允许开发者面向接口编程,文中介绍的非常详细,需要的朋友可以参考下2024-10-10
springboot+mybatis-plus 两种方式打印sql语句的方法
这篇文章主要介绍了springboot+mybatis-plus 两种方式打印sql语句的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-10-10
这篇文章主要介绍了Java语言面向对象编程思想之类与对象实例详解，还是十分不错的，这里给大家分享下，需要的朋友可以参考，希望能帮到你2021-08-08
Java基于装饰者模式实现的图片工具类实例【附demo源码下载】
这篇文章主要介绍了Java基于装饰者模式实现的图片工具类,结合完整实例形式分析了装饰者模式实现图片的判断、水印、缩放、复制等功能,并附带demo源码供读者下载参考,需要的朋友可以参考下2017-09-09
使用Maven Archetype插件构建Maven工程原型模板的实例
下面小编就为大家分享一篇使用Maven Archetype插件构建Maven工程原型模板的实例，具有很好的参考价值，希望对大家有所帮助2017-12-12
这篇文章主要介绍了基于java构造方法中对Vevtor添加元素的源码分析，有需要的朋友可以借鉴参考下，希望可以对大家有所帮助，祝大家早日升职加薪2021-09-09
这篇文章主要介绍了java8 Stream流逐行处理文本文件的相关资料，文中讲解非常细致，代码帮助大家更好的理解和学习，感兴趣的朋友可以了解下2020-07-07
最新评论