Java代码注释规范详解
代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用。 基本的要求: 1、注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。 2、注释内容准确简洁 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。 3、基本注释(必须加) (a) 类(接口)的注释 4、特殊必加注释(必须加) (a) 典型算法必须有注释。 备注:此类注释格式暂无举例。具体的注释格式自行定义,要求注释内容准确简洁。 5、注释格式: 1)、单行(single-line)注释:“//……” @author 对类的说明 标明开发该类模块的作者 6、例子: /** 建立一个用于操作数组的工具类,其中包含这常见的对数组的操作的函数:最值。 @author 张三 @version v. */ public class ArrayTool{ /** 获取整形数组的最大值 @param arr 接收一个元素为int类型的数组 @return 该数组的最大的元素值 */ public int getMax(int arr){ int Max = ; return Max; } } 输入命令如下图: 然后在如下的目录下查看,最后点击 index.html:
以上内容给大家分享了Java代码注释规范,希望对大家有所帮助。 您可能感兴趣的文章:
(编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |