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代码注释规范，希望对大家有所帮助。
相关文章
这篇文章主要介绍了SpringSecurity 自定义表单登录的实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-01-01
这篇文章主要给大家介绍了关于StringBuilder为什么线程不安全的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用StringBuilder线程具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧2019-08-08
这篇文章主要介绍了activiti获取流程图的方法,需要的朋友可以参考下2014-08-08
使用位运算、值交换等方式反转java字符串的多种方法（四种方法）
这篇文章主要介绍了使用位运算、值交换等方式反转java字符串，本文通过四种方式给大家讲解，给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2020-07-07
下面小编就为大家带来一篇Maven优雅的添加第三方Jar包的方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-09-09
这篇文章主要给大家介绍了非常全面的Java异常处理的相关资料，全文干货，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-11-11
这篇文章主要介绍了Java环境变量配置教程，简单介绍了java的环境变量设置方法，感兴趣的小伙伴们可以参考一下2016-06-06
java中使用try-catch-finally一些值得注意的事(必看)
下面小编就为大家带来一篇java中使用try-catch-finally一些值得注意的事(必看)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2016-08-08
这篇文章主要介绍了Java创建子线程的两种方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-05-05
优秀的文章也不少，但是Java完整版的好像不多，我把所有的写一遍巩固下，同时也真诚的希望阅读到这篇文章的小伙伴们可以自己去从头敲一遍，不要粘贴复制！希望我的文章对你有所帮助，每天进步一点点2021-07-07
最新评论