源码网商城,靠谱的源码在线交易网站 我的订单 购物车 帮助

源码网商城

Java代码注释规范详解

  • 时间:2021-06-18 18:02 编辑: 来源: 阅读:
  • 扫一扫,手机访问
摘要:Java代码注释规范详解
代码附有注释对程序开发者来说非常重要,随着技术的发展,在项目开发过程中,必须要求程序员写好代码注释,这样有利于代码后续的编写和使用。 [b]基本的要求:[/b] [b]1、注释形式统一[/b] 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。 [b]2、注释内容准确简洁[/b] 内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。 [b]3、基本注释(必须加)[/b] (a) 类(接口)的注释 (b) 构造函数的注释 (c) 方法的注释 (d) 全局变量的注释 (e) 字段/属性的注 备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或 VO对象的getter、setter方法不需加注释。具体的注释格式请参考下面举例。 [b]4、特殊必加注释(必须加)[/b] (a) 典型算法必须有注释。 (b) 在代码不明晰处必须有注释。 (c) 在代码修改处加上修改标识的注释。 (d) 在循环和逻辑分支组成的代码中加注释。 (e) 为他人提供的接口必须加详细注释。 备注:此类注释格式暂无举例。具体的注释格式自行定义,要求注释内容准确简洁。 [b]5、注释格式:[/b] 1)、单行(single-line)注释:“//……” 2)、块(block)注释:“/*……*/” 3)、文档注释:“/**……*/” 4)、javadoc注释标签语法 @author 对类的说明 标明开发该类模块的作者 @version 对类的说明 标明该类模块的版本 @see 对类、属性、方法的说明 参考转向,也就是相关主题 @param 对方法的说明 对方法中某参数的说明 @return 对方法的说明 对方法返回值的说明 @exception 对方法的说明 对方法可能抛出的异常进行说明 [b]6、例子: [/b]
/** 
建立一个用于操作数组的工具类,其中包含这常见的对数组的操作的函数:最值。 
@author 张三 
@version v. 
*/ 
public class ArrayTool{ 

/** 
获取整形数组的最大值 
@param arr 接收一个元素为int类型的数组 
@return 该数组的最大的元素值 
*/ 
public int getMax(int arr){ 
int Max = ; 
return Max; 
} 
} 
输入命令如下图: [img]http://files.jb51.net/file_images/article/201602/2016020311514918.jpg[/img] 然后在如下的目录下查看,最后点击 index.html: [img]http://files.jb51.net/file_images/article/201602/2016020311514919.jpg[/img] [img]http://files.jb51.net/file_images/article/201602/2016020311514920.jpg[/img] [img]http://files.jb51.net/file_images/article/201602/2016020311514921.jpg[/img] 以上内容给大家分享了Java代码注释规范,希望对大家有所帮助。
  • 全部评论(0)
联系客服
客服电话:
400-000-3129
微信版

扫一扫进微信版
返回顶部