1、在Android studio中进行打开一个项目的文件之后,然后进行点击Android stuio中菜单中的“tools”的选项。
2、这样就会弹出了下拉菜单中,进行选中下拉菜单中的“generate javadoc”的选项。
3、就会弹出了specify generate javadoc scope的窗口,在output directorys中进行输出的路径。
4、可在运行的窗口中查看到的是文件正在生成,根据文件大小,对生成的时间上等待。
5、文件生成完毕之后,进入到了resource的文件,进行双击index.html的选项即可。
6、这样就同index.html中查看代码中所有类的方法,如果有添加注释的信息,也可查看到。
使用 //注释 //后面就是注释内容。
使用 /* */ 中间的就是注释内容。
使用/** */注释,这种就会生成javadoc注释,可以在类名,方法名、字段名上方输入/**回车即可自动生成doc模版。
Android studio生成javadoc文件乱码怎么办?
一般使用Android Studio生成javadoc会有两个问题:
空指针异常
文档乱码
解决办法如下:
第1个问题:Tools --> Generate JavaDoc -->打开对话框活,在"Other command line arguments"输入 “-bootclasspath /Users/用户名/sdk/platforms/android-14/android.jar”,红色部分每个人电脑不尽相同,指定android.jar的位置就行。
第2个问题:同上打开对话框后,在"Other command line arguments"追加输入(参数之间勿忘空格)“-encoding utf-8 -charset utf-8”
经过这样设置后,已经能够成功生成文档。期间有一些报错和警告,根据提示修改即可。
当然,使用jdk1.6的时候问题较多,升级到jdk1.7+后,会顺利很多,警告和错误要少很多。