Java基础——注释规范

Posted ---江北

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Java基础——注释规范相关的知识,希望对你有一定的参考价值。

一、注释格式分类

  1、单行(single-line)注释://……

  2、块(block)注释:/*……*/

  3、文档注释:/**……*/

  javadoc有如下:

  

 

二、加注释的场景:

  1. 基本注释(必须加)
    (a)类(接口)的注释
    (b)构造函数的注释
    (c)方法的注释
    (d)全局变量的注释
    (e)字段/属性的注释

  2. 特殊必须加注释(必须加)
    (a)典型算法 必须有注释。
    (b)在代码不明晰处必须有注释。
    (c)在代码修改处加上修改标识的注释。
    (d)在循环和逻辑分支组成的代码中加注释。
    (e)为他人提供的接口必须加详细注释。

三、注释示例

    类的注释——请使用IDE的模板定义类注释模板

/**
 * 测试类
 * @author jiangbei01
 * @version 1.0
 * 
 *
 */
public class Test01 {

    字段属性注释

private String username;//用户名,字段属性注释

    全局变量注释

  /**统计次数*/
    private final int count= 18;

    方法注释

  /**
     * 测试方法
     * @param n 循环次数
     * 
     */
    @Test
    public void fun1(int n){

 

以上是关于Java基础——注释规范的主要内容,如果未能解决你的问题,请参考以下文章

java基础:注释

Java基础

Java基础语法

零基础 快速学Java韩顺平 p20-26 快速掌握技术转义字符易犯错误注释代码规范

Java基础

Java基础:第一章基础语法