Doc.java 文件
package com.zhang.base;
/**
* @author Zhang ******
* @version
* @since 1.8
*/
//类的注释
public class Doc {
String name;
//方法的注释
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
通过tools导航下的 generate JavaDoc
添加转换文件以及生成文件路径
然后点击index.html文档,查看API文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。——百度百科