zoukankan      html  css  js  c++  java
  • 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 对方法的说明 对方法可能抛出的异常进行说明

     1 /** 
     2 建立一个用于操作数组的工具类,其中包含这常见的对数组的操作的函数:最值。 
     3 @author 张三 
     4 @version v. 
     5 */
     6 public class ArrayTool{ 
     7  
     8 /** 
     9 获取整形数组的最大值 
    10 @param arr 接收一个元素为int类型的数组 
    11 @return 该数组的最大的元素值 
    12 */
    13 public int getMax(int arr){ 
    14 int Max = ; 
    15 return Max; 
    16 } 
    17 }
    ------------ ----------------https://www.gnsoft.ltd------------------- ------------
  • 相关阅读:
    顶级Kagglers的心得和技巧
    大数加法
    TensorFlow 2.0高效开发指南
    Java 8 特性 —— Stream
    Java 8 特性 —— 函数式接口
    Java 8 特性 —— 方法引用
    Java 8 特性 —— 默认方法和静态方法
    Java 8 特性 —— lambda 表达式
    Effective Java 读书笔记
    jQuery动态添加、删除按钮及input输入框
  • 原文地址:https://www.cnblogs.com/guozht/p/7685753.html
Copyright © 2011-2022 走看看