“注释”是程序员的自我修养

Posted 2021-11-23 Code大队长

开篇引言
公司早会上，项目经理怒气冲冲，大声质问：“这么明显的BUG，谁TM写的，还没有注释，给我查SVN的提交记录，扣除这个程序员的KPI”
项目组的小码农们紧张的空气都凝固了，害怕被揪出来是自己写的。
小王：“经理，我正在查。。。”
过了几分钟。
小王，一脸震惊，口中嘟囔着说：“这不可能吧？怎么会是他？”
众人凑过去一看，错误代码竟然是项目经理两年前自己提交的！
当初要是写上注释，何必今日这么尴尬呀！今天就跟大家聊一聊代码注释！

注释是在程序中添加的说明性信息，方便程序员更好的阅读代码。本文先介绍一下Java中的注释的基本概念和案例，然给大家整理了一些大公司的注释书写规范，供大家参考！

单行注释：

// 我是单行注释

多行注释：

/* 我是多行注释 */

文本注释

/** 我是文本注释 */

举个例子：

/**
 * @description：演示注释用法的案例程序
 * @author     ：Code大队长
 * @date       ：2021-05-25
 */

/*
 * 类名：HelloWorldDemo
 * 关键字：public、class
 */
public class HelloWorldDemo {

    //这是程序的入口函数，这个地方是固定写法
    public static void main(String[] args) {
        //这句话是输出遇见，输出的内容会打印在控制台中
        System.out.println("Hello World!");
    }
}

注释的格式没有统一的规范，每个公司可能会稍有区别，我这里有一份阿里巴巴的Java开发手册，里面介绍了注释的相关规定，提供给大家作为参考！

文档下载地址：链接：https://pan.baidu.com/s/16vq8mRQxtx3n9wYz2SFhSQ
提取码：3r51