注释的重要性

编写程序的时候，总需要为程序添加一些注释，用以说明某段代码的作用，或者说明某个类的用途，某个方法的功能，以及该方法的的参数和返回值的数据类型以及意义等。

程序注释的作用非常大，很多初学者在刚刚学习 Java 程序的时候，会很努力的写程序，不太会注意添加注释。认为添加注释是一种浪费时间，没有意义的事情。经过一段时间的学习，注意到程序书写得不足，需要重构。于是打开源码，以为可以很轻松地改写原有代码，但这个时候会发现理解原来写的代码会非常的困难，很难理解原有的编程思路。

为什么需要添加注释，至少有如下三方面的考虑：

1. 永远不要过于相信自己的理解能力
2. 可读性第一，效率第二
3. 代码即文档

程序注释是源代码的一个重要部分，对于一份规范的程序源代码而言，注释应该占到源代码的三分之一以上。几乎所有的编程都提供了注释的方法，一般包括，单行注释，多行注释。java语言也不例外，不仅包括单行注释，多行注释，还提供了一种文档注释。java语言的注释一共有三种类型。

java的三种注释

单行注释：在程序中注释一行代码

多行注释：一次性的将程序中的多行代码注释掉。

文档注释：注释允许你在程序中嵌入关于程序的信息。

单行注释，多行注释单行注释：

单行注释：将双斜线//放到需要注释的内容之前就可以了。

多行注释：使用/* 和 */ 将程序中需要注释的内容包含起来。/* 表示注释的开始 */ 表示注释的结束。

文档注释

java还提供了一种功能更强大的注释形式，文档注释。它以 /** 开始，以 */结束。

注释的例子：

 package com.bbzd.basic;

/**
 * 这是文档注释
 * @date 2022/9/30 - 16:55
 */public class HelloWord {

    /*
    这是多行注释
     */    public  static   void  main(String[] args) {
        //这是单行注释
        System.out.println("这是第一个Java程序");
    }
}  

总结

1. 代码格式，注释其实很重要，但又容易被忽略。