java基础-注释

    java有三种注释的方式，分别是单行注释、多行注释、文档注释，下面介绍一下这几种注释的使用场景和一些行业规范。

单行注释

    以//开头，既可以在注释的开头使用//进行标记，注释的内容是从//开始到行尾。
    单行注释主要用于方法内部的注释，注释时需要单独另启一行。//后面空格后再跟上具体的注释内容。

多行注释

    以/*开头，以*/结束的格式将一段比较长的注释文本括起来。一般也用在方法内部。为了保持代码整洁格式统一，需要有代码对齐，首尾前后不应有其它内容（包含代码和注释）。

文档注释

    和多行注释类似，只是开头的形式改成/**。同样能注释多行。一般用在类，方法，类属性名上用来说明类作用，方法作用、参数，类属性作用等。使用文档注释时需要遵循Javadoc规范。为了提高阅读效率，我们强烈建议在类、类属性、类方法、抽象方法、接口方法上使用文档注释。在IDE中开发调用对应的方法时，不需要进入的类或方法内部就可以悬浮提示类描述、方法的参数、返回值的意义。

注释规约

• 为了自己以后的阅读和后来人阅读代码，关键代码逻辑最好加上注释，注释内容尽可能的详细。
• 注释是用来说明情况，不要使用”半吊子“的英文来注释，使用通俗易懂的语言描述清楚即可
• 整个工程的类，方法，类变量必须使用符合Javadoc规范的注释
• 代码修改时，相应的注释也应修改。防止代码逻辑和注释不同步，坑了后来人
• 好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释又是相当大的负担
• 特殊注释
  1. TODO
     这个特殊注释用来标识该处代码还未实现或还需要改动。待实现或改动点需要在后面进行简略说明。目前IDE已经能很好的支持该特殊注释，在IDEA中最下角一般都会有TODO工具栏。
  2. FIXME
     这个特殊注释用来标识该处代码时错误的，上线后引起线上问题的代码。通常上线前需要修复掉。错误的原因和修复方式同样要在后面进行简略说明。和TODO类似，IDEA也能很好的支持。