关于java的注释

Java编程中的注释类型与颜色管理

原创已于 2023-12-21 20:05:16 修改 · 498 阅读

7 ·

CC 4.0 BY-SA版权

文章标签：

#java #intellij-idea #c# #c语言

于 2023-12-21 19:47:26 首次发布

JavaSE 专栏收录该内容

49 篇文章

订阅专栏

本文介绍了Java编程中注释的重要性，包括单行注释、多行注释（避免嵌套）和文档注释的使用，以及如何在Idea开发工具中修改注释颜色。

Java中关于注释的说明

一、了解注释

注释在代码中具有很重要的作用，在最初开始写代码的时候，不书写注释自己还可以记得住自己写的代码是什么含义，但是慢慢的，代码越写越多，没有注释，回头看看自己写过的代码，很难记起当时这个方法的作用，或者声明的是什么，所以写注释是一个非常好的习惯，也是对代码起到规范作用😊
注释也可以用来，如果写了一段代码，想要换一种方法，还不想删除原来的方法，就可以将原有的方法进行注释掉，代码不会编译运行注释部分的文字或者代码！

二、注释的三种类型

单行注释

用上一篇文章中的Hello,World!进行说明

public class Hello{
    public static void main(String[] args){
        System.out.println("Hello,World!"); //在这里输出一个Hello,World!
    }
}

单行注释书写为两个//，后边加上要注释的内容即可。

多行注释

public class Hello{
    public static void main(String[] args){
        System.out.println("Hello,World!");
        /*System.out.println("Hello,World!");
        System.out.println("Hello,World!");
        System.out.println("Hello,World!");
        System.out.println("Hello,World!");*/
    }
}

多行注释书写为/**/（两个星号中间的部分为被注释部分）。

多行注释不要去嵌套！！

因为/**/是一个首位符号，如果嵌套的话，首符号会自动匹配第一个尾符号进行注释，下面举例说明一下。

public class Hello{
    public static void main(String[] args){
        System.out.println("Hello,World!");
        /*System.out.println("Hello,World!");
        /*System.out.println("Hello,World!");
        System.out.println("Hello,World!");*/
        System.out.println("Hello,World!");*/
    }
}

像这样，大家就可以看到，中间有一部分没有被注释掉，因为首符号只会去找第一个匹配上的尾符号，所以会导致漏掉想要注释的部分。

文档注释

/**
*@author落满樱花的羊
*@Version 01
**/
public class Hello{
    public static void main(String[] args){
        System.out.println("Hello,World!"); 
    }
}