导出word格式的Javadoc
最近要编写项目详细设计文档,作为程序员当然想看看有没有能够自动生成的办法,生成详细设计文档,然后再在生成的基础上略做修改就好了(偷懒大法~),还真有,特此分享!
工具
- IDEA
- docflex
- javadoc
- WORD
准备
- 下载docflex,http://www.filigris.com/flexdoc-javadoc/ 或者使用我提供的版本,链接:https://pan.baidu.com/s/1EMQ8JeBx0ISLKiti3pLd8w
提取码:1468 - 解压docflex
- 注册账号,获取license
- 将license放到docflex的lib文件夹
使用方式
- 打开IDEA的tools菜单
- 点击【Generate Javadoc】
- 在Command line arguments 中填入:-doclet com.docflex.javadoc.Doclet -docletpath C:\Users\Administrator\AppData\Roaming\JetBrains\IntelliJIdea2020.1\plugins\docflex-javadoc-1.6.1\lib\docflex-javadoc.jar -encoding UTF-8
这里面的C:\Users\Administrator\AppData\Roaming\JetBrains\IntelliJIdea2020.1\plugins\docflex-javadoc-1.6.1\lib\docflex-javadoc.jar 为该Jar包的全路径
-
最后那个是docflex的绝对路径
-
点击Generate
-
在弹出的docflex窗口后中选择RTF,输入文件名,点击Run即可
一定点下箭头,选这个javadoc\PlainDoc.tpl,不要点下箭头旁边的... 我这会有问题
然后选择RTF格式,Output folder是输出目录 testpro是输出文件的名称,这个可以自行修改,修改好了后,点击Run就行了
-
将生成的文件用word打开,另存为,选择docx即可
生成文档形式
生成文档如下,可以直接这样使用,也可以根据自己的需求稍作修改。