如何在Java 中使用注释

   在编写程序时候，经常需要添加一些注释，用于描述某段代码的作用。一般来说，对于一份规范的程序源代码而言，注释应该占到 1/3 以上，因此，注释是源代码的重要组成部分，一定要加以重视

   Java中注释有三种类型：单行注释，多行注释，文档注释

                                     

    被注释的代码快在程序中是不会被执行的

我们可以通过 javadoc 命令 从文档注释中提取内容，生成程序的API文档 

                                           

打开首页，查看下生成的API文档

                                           

PS：使用文档注释时还可以使用javadoc 标记，生成更详细的文档信息：

          @auhor 标明开发该模块的作者

          @version 标明该类模块的版本

          @see 参考转向，也就是相关主题

          @param 对方法中某参数的说明

          @return 对方法返回值的说明

           @exception 对方法可能抛出的异常进行说明