Java中的注释规范：单行注释、多行注释、文档注释

翻滚的胖子
2023-05-26 18:49:50
后端技术
Java Python

Java中的注释规范：单行注释、多行注释、文档注释

一、前言

注释是程序中必不可少的一部分，能够让代码更加易读易懂，也有助于代码的维护和修改。Java中的注释有三种：单行注释、多行注释和文档注释。

二、单行注释

单行注释以“//”开头，只能注释一行，注释内容与//之间不需要空格。单行注释通常用于简短的注释说明或者调试代码。

//这是一个单行注释
public class Demo{
    //这是一个方法
    public void test(){
        int a=1;//这是一个变量的单行注释
    }
}

三、多行注释

多行注释以“/*”开头，“*/”结尾，可以注释多行，注释内容一般不超过几行。多行注释通常用于注释方法、类或者代码块。

/*
这是一个多行注释
可以注释多行
*/
public class Demo{
    /*
    这是一个方法
    可以注释多行
    */
    public void test(){
        /*
        这是一个代码块
        可以注释多行
        */
        int a=1;
    }
}

四、文档注释

文档注释以“/**
”开头，“*/”结尾，可以注释多行，一般用于注释类、方法和变量等，同时可以生成API文档。文档注释的内容需要遵循JavaDoc规范，包括注释标签和注释说明。

/**
* 这是一个类的文档注释
* 可以注释多行
*/
public class Demo{
    /**
    * 这是一个方法的文档注释
    * @param a 参数a
    * @param b 参数b
    * @return 返回值
    */
    public int test(int a, int b){
        /**
        * 这是一个变量的文档注释
        */
        int c=1;
        return a+b;
    }
}