注释的重要性

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

文章目录

• 前言
• 一、java注释的重要性
• 二、Java的注释分为三种
• 三、注释提高代码的可识别性和可读性
• 总结

---

一、java注释的重要性

（1） 平时我们在写代码中代码量比较小的时候还可以看得懂自己写的

但一旦项目结构比较复杂起来，我们就需要注释

有一个良好的注释习惯是对一个程序员最基础的要求。

（2）因为良好的注释，对于公司来说，

注释都会给自己带来好的印象增加面试通过的机率

（3）写注释的时候一定也要注意规范

还有注释所写的文字要简洁明了

更加具体的体现程序的运行

     

二、Java的注释分为三种

(1) 单行注释

代码如下（示例）：这就是平时我们所常写的单行注释

package LianXiHuang;

public class Huang60 {
    public static void main(String[] args) {
        //单行注释:  打印括号内的内容   
        System.out.println("Hello,Wrold");
    }
}

(2) 多行注释

代码如下（示例）：多行注释在我们平时面对比较多的文字,需要注释中便捷的方法

package LianXiHuang;

public class Huang60 {
    public static void main(String[] args) {
        /*注释:  打印括号内的内容
                输出1~9的阿拉伯数字
                输出到7的时候，
                作出一个判断
                输出 Hello world
                                     */
        for (int i = 0; i < 10; i++) {
            System.out.println(i);
            if(i==7){
                System.out.println("Hello,Wrold");
            }

        }
    }
}

提示：多行数组能更加细节的体现出程序的运作

(3) 文档注释

代码如下（示例）：这里的注释信息可以自动被javadoc.exe命令解析提取并生成到帮助文档当中。

public class wwe5 {
    public static void main(String[] args) {
        /**
        for (int i = 0; i < 10; i++) {
            System.out.println(i);
            if(i==7){
                System.out.println("Hello,Wrold");
            }

        }
         **/
    }
}

public class wwe5 {
    public static void main(String[] args) {
        /**
        for (int i = 0; i < 10; i++) {
            System.out.println(i);
            if(i==7){
                System.out.println("Hello,Wrold");
            }

        }
         **/
    }
}

---

总结

提示：这里对文章进行总结：

   (1).什么是注释，有什么用？
        注释是对java源代码的解释说明。
        注释可以帮程序员更好的理解程序

   (2).注释不是写的越多越好，精简，主线清晰，每个注释都应该是点睛之笔。（以后慢慢锻炼）