Java注释

java注释

解释

对代码的说明。

人的记忆力是有限的，而且别人也可能会需要去了解你写的代码，这个时候注释的作用就体现了出来。尽管有多种分类和用法，但是殊途同归的是最终都是为了人对代码的理解而服务。

分类

• 单行注释

  //这是单行注释，双斜杠后的内容不会被解释执行
  

解释单行代码

• 多行注释

  /*
  	这是多行注释，这个区间内的内容不会被解释执行
  */
  

解释多行代码

• 文档注释

  • 用法1：方法注释

    /**
    *
    * @param 方法的参数
    * @return 方法的返回值
    * @throws 抛出的异常
    */
    

  • 用法2：使用HTML标签编写的注释

    /**
    *
    * <p>还可以在文档注释中使用HTML标签。</p>  
    * <h2>方法名</h2>  
    * 当JavaDoc工具处理这些注释时，它会解析HTML标签并生成相应的HTML文档。
    * 这些文档通常具有统一的样式和布局，使得API文档看起来整洁且易于阅读。
    * 注意：不是所有的html标签都支持。
    */
    

  • 用法3：类注释：

    /**
    * 
    * 类的作用
    * 使用场景
    * 
    * @author 作者名  
    * @version 版本号
    */
    

  • 用法4：字段注释：

    /**
    * 解释下方的字段
    */
    

与前两种注释的不同是，文档注释可以通过特定的工具（如javadoc），可以从文档注释中提取信息并生成API文档，方便其他开发人员查阅，正如它的名称一样：文档注释。

总结

java注释各自有各自的不同应用场景，上述只是描述了几种常用的注释情况，但是不仅限于此，不同的人和不同的公司有不同的喜好，只要能合理运用注释，实现它存在的价值即可。

在不同的代码编写工具中有不同的快捷键。写注释很重要，这是一种良好的编程习惯，要不然代码出bug，都不知道去哪里哭。