注释——能更好地帮助理解代码

前言

很多人在写代码的时候会忽略注释，认为只是初学时有必要注释，学到后面或许是对自己的编程能力很自信，或许是懒得写，出于这样那样的原因到后期基本上就不再注释了，可这是一个误区，代码注释还是非常有必要的。

正文

众所周知，代码编写都是先易后难，越到后面困难level越高，前面简单的代码尚且不加注释，后面难的代码不加注释后期重新来看就很难看懂，代码的可读性巨差，影响编程开发效率。比如:

import java.util.Scanner;
public class Demo6 {
    public static void main(String[] args) {
        Scanner sc = new Scanner(System.in);
        System.out.println("请输入一个数：");

        int n = sc.nextInt();
        for (int i = 1; i <= n; i++) {
            for (int j = n - i; j >= 0; j--) {
                System.out.print("*");
            }
            System.out.println();
        }
    }
}

import java.util.Scanner;
// 1.导包
//输入高度，输出倒直角三角形
public class Demo6 {
    public static void main(String[] args) {
// 2.创建录入对象
        Scanner sc = new Scanner(System.in);
//给定一个高度
        System.out.println("请输入一个数：");
//给定高度参数n
        int n = sc.nextInt();
        for (int i = 1; i <= n; i++) {
// 第一个for控制*高度，有几行
            for (int j = n - i; j >= 0; j--) {
//     第二个for控制每一行*个数，每一行有几个*，
// 其中int j的初始值n-i为最多的那一行星星个数，
//      内部嵌套的for循环是定义每一行*的个数，
// 例如在n为5时，第一行：i=1，j=n-i=5-1=4，那么 j >= 0成立，输出一个*；i=2，j=n-i=5-2=3，那么 j >= 0成立，输出一个*；
// i=3，j=n-i=5-3=2，那么 j >= 0成立，输出一个*；i=4，j=n-i=5-4=1，那么 j >= 0成立，输出一个*；
// i=5，j=n-i=5-5=0，那么 j >= 0成立，输出一个*；一共输出5个*
//     第二行 ：i=2，，j=n-i=5-2=3，那么 j >= 0成立，输出一个*；i=3，j=n-i=5-3=2，那么 j >= 0成立，输出一个*；
// i=4，j=n-i=5-4=1，那么 j >= 0成立，输出一个*；i=5，j=n-i=5-5=0，那么 j >= 0成立，输出一个*；一共输出4个*    ……
//      第五行 ：i=5，j=n-i=5-5=0，那么 j >= 0成立，输出一个*；一共输出1个*
                System.out.print("*");
            }
            System.out.println();
        }
    }
}

明显第二个有注释的代码更好理解。

代码有时候不止是给自己看的，有时候还要给别人看，好的注释就是一座桥梁，方便双方往来，即便是自己写的代码，回过头来看的时候也不一定还能看懂，所以养成良好的注释习惯会对代码理解大有帮助。