55、如何制作API

55、如何制作API

只需要在自己所定义的类中，做出特定的注释即可：

package lee;

/**
 * Description:
 * 网站：<a href="http://www.cctv.com">CCTV频道</a><br>
 * Copyright(c),1999-2021,Eric<br>
 * This program is protected by copyright laws. <br>
 * Program Name:Eric<br>
 * Date:2021-02-07<br>
 * @author Eric
 * @version 1.0
 */
public class JavadocTest {
    /**
    *简单测试成员变量
     */
    protected String name;
    /**
     * 主方法，程序的入口
     */
    public static void main(String[] args){
        System.out.println("Hello World!");
    }
}

注意注释的写法，用的是/** */的写法，第一段注释是对该类整体的描述，包括作者，日期，产权，概要介绍等。

后两段注释，是对成员方法和成员变量的描述。

如何使用IDEA生成API：

编辑好之后，点击IDEA上方的Tools选项，之后再从中选取GenerateJavaDoc

之后再选取File ’…\src\lee\JavadocTest.java’,再在Output directorary确定你想要的输出位置，

在Locale：中输入zh_CN

在Other command line arguments：中传入JavaDoc的参数，一般这样写

-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

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

package lee;

/**
 * Description:
 * 网站：<a href="http://www.cctv.com">CCTV频道</a><br>
 * Copyright(c),1999-2021,Eric<br>
 * This program is protected by copyright laws. <br>
 * Program Name:Eric<br>
 * Date:2021-02-07<br>
 * @author Eric
 * @version 1.0
 */
public class Test {
    /**
    *简单测试成员变量
     * @param name 该参数说明信息，表示姓名的字符串
     * @return 返回值说明信息,打招呼的字符串
     */
    public String hello(String name){
        return name + "hello";
    }
}

@param,@return实现后的样子: