Java程序的注释与Javadoc的使用

Java程序的注释总共有三种，分别是：单行注释、多行注释、文档注释。

其中单行注释为        // 单行注释

多行注释为        /*       

                        多行注释

                         */

文档注释为        /**        

                        * 文档注释

                        */

 Javadoc的使用

        一：新建记事本，编写代码并写上部分注释。

         二：将文件另存为A.java，并保存。

        

         三：打开cmd，输入javadoc -author -version A.java命令时，当使用JDK8时，文件中有中文字符时，在进行javac编译会出现”错误“：编码GBK的不可映射字符。

由于JDK是国际版，我们在javac编译时，编译程序首先会获得我们操作系统默认采用的编码格式（GBK)。然后JDK就把Java源文件从GBK编码格式转换为Java内部默认的Unicode格式放入内存中，然后javac把转换侯的Unicode格式的文件编译成class类文件，此时，class文件是Unicode编码的，它暂存在内存中，紧接着，JDK将此以Unickode格式编码的class文件保存到操作系统中形成问见到的class文件。当我们不加设置编译时，相当于使用了参数：javac -encoding GBK A.java，就会出现不兼容的情况。来自Javadoc注释基本介绍和基本用法 - 简书 (jianshu.com)

         解决方法是：使用-encoding参数指明编码方式：javac -encoding UTF-8 A.java，就可以了。

         四：打开生成的index.html文件，就是生成API文档。

        五：打开生成API文档并查看我们记事本所写的javadoc注释。