JavaDoc
在Android Studio中,可以使用JavaDoc生成帮助文档。使用也比较方便,菜单选择”Tool->Generate JavaDoc”。
此外,我们还可以使用更强大的DoxyGen工具,在帮助文档中增加类继承关系图、函数调用关系图等。
DoxyGen
使用DoxyGen工具生成文档,有下面两种用法:
1.可以使用图形工具Doxywizard,图形化配置输出选项,然后运行即可。
2.也可以用命令行doxygen DoxyFile生成文档。
一般的,用DoxyGen生成文档,还要依赖于Graphviz图形生成工具(graphviz-2.38.msi)、微软的CHM编译器html help(htmlhelp.exe),可自行搜素安装。
Graphviz是一个图形可视化软件。Doxygen使用Graphviz生成各种图形,例如类的继承关系图、合作图,头文件包含关系图等。可以从Graphviz的网站下载Graphviz的最新版本。Doxygen使用了Graphviz的布局引擎dot,所以在文档中将其称作dot。
Doxygen在输出HTML文档时,可以自动准备用于制作CHM的项目文件(.hhp)、目录文件(.hhc)和索引文件(.hhk)。用HTML Help Workshop中的CHM编译器(hhc.exe)编译后生成CHM文件。
DoxyFile配置文件的部分选项如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
// 输出目录
OUTPUT_DIRECTORY = D:/Code_baidu/nuomi/merchant-android/doc
// 输入文件
INPUT = ../app/src/main/java
*.js \
*.cxx
// 是否能查看source
SOURCE_BROWSER = YES
// 生成的html文件目录
HTML_OUTPUT = html
// 强烈注意:如果要生成chm文档,这里必须是相对目录,而且是相对于HTML_OUTPUT目录。如果使用绝对目录,生成失败!
CHM_FILE = ../merchant-android.chm
// 调用关系图
CALL_GRAPH = YES
CALLER_GRAPH = YES
|
其他更详细的选项配置可自行探索。