用android studio 生成javadoc

文档功能注释是前提

通常我们自己封装的SDK都要生成一个API文档，不然你让别人怎么用啊。好在这个文档是不需要我们自己写的，只要我们在封装SDK的时候养成好的习惯，按照指定的格式输写注释，就可以用IDE自带的工具一键生成文档了。

注释的风格是这样的:

/**
* Created by pony on 2016/7/22.
* 蓝牙工具类
*/
public class BluetoothHelper {
/**
* 扫描蓝牙设备
*
*/
public void startScan()
{
}
/**
* 连接蓝牙设备
* @param device
* @return 返回连接结果
*/
public int connnect(int device)
{
return -1;
}
}

如何导出文档

tools-generage javadoc



有几个点说明一下:

include test sources

这个选项可以不选，这个是指你工程中自动生成的测试类，一般可以不要。

other command line arguments

这个一般加上 -encoding utf-8 -charset utf-8，否则生成的文档中文会显示乱码。

生成的样式

生成文档成功后，根目录会有个index.html，通过这个打开就可以了，如下: