java笔记 程序注释

注解是什么

Java注解的意义在于为代码提供元数据，用于描述代码的某些属性或行为。

Java注解是一种代码级别的说明，它们可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明和注释。虽然注解本身不直接影响代码的执行，但它们可以被用来生成文档、报告或者通过反射在运行时读取信息，从而影响程序的行为。例如，注解可以被编译器用来检查代码的正确性，或者被框架用来配置和控制组件的行为。 

Java注释有几种类型

1. 单行注释：使用双斜杠（//）表示，注释内容在双斜杠后面，直到该行结束。
2. 多行注释：使用斜杠星号（/）和星号斜杠（/）表示，注释内容在这两个符号之间，可以跨越多行。
3. 文档注释：使用斜杠星号（/**）和星号斜杠（*/）表示，注释内容在这两个符号之间，可以跨越多行。这种注释主要用于生成Java文档，可以被javadoc工具解析生成HTML格式的API文档。

 

单行注释 

public class DocDemo {
    public static void main(String[] args) {
        
        //声明名称，名称初始化赋值是
        String name="卡布厨房";
    }
}

 多行注释

public class DocDemo {
    public static void main(String[] args) {

        /*
        * 多行注释
        * 声明一个名称为卡布厨房
        * */
        String name="卡布厨房";

    }
}

 文档注释

public class DocDemo {

    /**
     * 文档注解
     * 程序主入口
     * @param args 方法蚕食是数组
     */
    public static void main(String[] args) {
    }

}

 

结语

学习了关于在代码中如何写注解，增加代码可读性、以及该代码的用途，为何这样编写等相关说明。