Java | 注释

为什么用注释

注释是为了方便程序的阅读，java语言允许程序员在程序中写上一些说明性的文字，来提高程序的可读性，这些文字是注释。
但是注释不会出现在字节码文件中，就是说：java编译器在编译的时候会跳过注释的语句。而java根据注释的功能不同，能分为三种注释，单行注释、多行注释、文档注释。

单行注释

单行注释：以“//”开头，//后面的内容都为注释。

多行注释

多行注释：以“/*”开头，以“*/”结尾，在这之间的内容都为注释，多行注释的内容可以非常的灵活，可以在做为行内注释。

文档注释

文档注释：以“/**”开头，以“*/”结尾，注释中包含一些说明性的文字，及一些javaDoc的标签（可以生成API）

package com.frost.test;

/**
 * @author Frost
 * @Version 1.0
 */
public class World{
    /**
     * 主方法（方档注释）World
     * @param args
     */
    public static void main(String[] args/* 行内注释，不影响本行内容 */) {
        System.out.println("Hello World!");
        // 单行注释，对程序进行说明解释
    }
    
    /*
        行内注释也可以做为
        多行注释使用
    */
    
    /**
     * 这个文档注释
     */
    public void test(){
    }
    
    /**
     * 构造函数
     */
    public World(){}
} 

用文档注释成生一个API

直接使用上面的 World.java 来生成一个API

用这两个类来进行测试：

• 生成文档时文件编码需要转换为GBK，不然javaDoc可能报错。
• 在命令行里面进行当前文件所在的目录。
• 在命令行里面输入

    javadoc -d api_doc -windowtitle 测试API -doctitle zhushi -header GFrost的类 *.java

生成的文件在当前目录中，打开后的样式为：

下面中javadoc的常用的标记

• @author：指定Java程序的作者
• @version：指定源文件的版本
• @depreated：不推荐使用的方法
• @param：方法的参数说明信息
• @return：方法的返回值说明信息
• @see：“参见”，用于指定交叉参考的内容
• @exception：抛出异常的类型
• @throws：抛出的异常，和@exception同义

使用时的注意是：

javadoc工具只能处理文档源文件在类、接口、方法、成员变量、构造器和内部类之前的文档注释，别的地方的文档不处理。
  默认的时候，只处理public 和 protected 上面的注释，而对别的不管，如果想让私有方法也加入到API文档中，请在命令上面加上 (-private)

参考：
Undergoer_TW

---

关注公众号，随时获取最新资讯

细节决定成败!
个人愚见，如有不对，恳请斧正!