导出word格式的Javadoc(可用于快速生成项目详细设计文档)

导出word格式的Javadoc

​ 最近要编写项目详细设计文档,作为程序员当然想看看有没有能够自动生成的办法,生成详细设计文档,然后再在生成的基础上略做修改就好了(偷懒大法~),还真有,特此分享!

工具

  • IDEA
  • docflex
  • javadoc
  • WORD

准备

  1. 下载docflex,http://www.filigris.com/flexdoc-javadoc/ 或者使用我提供的版本,链接:https://pan.baidu.com/s/1EMQ8JeBx0ISLKiti3pLd8w
    提取码:1468
  2. 解压docflex
  3. 注册账号,获取license
  4. 将license放到docflex的lib文件夹

使用方式

  1. 打开IDEA的tools菜单
  2. 点击【Generate Javadoc】
  3. 在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包的全路径

  1. 最后那个是docflex的绝对路径

  2. 点击Generate

  3. 在弹出的docflex窗口后中选择RTF,输入文件名,点击Run即可

    一定点下箭头,选这个javadoc\PlainDoc.tpl,不要点下箭头旁边的... 我这会有问题

    然后选择RTF格式,Output folder是输出目录 testpro是输出文件的名称,这个可以自行修改,修改好了后,点击Run就行了

  4. 将生成的文件用word打开,另存为,选择docx即可

生成文档形式

生成文档如下,可以直接这样使用,也可以根据自己的需求稍作修改。

相关推荐
SUPER52662 小时前
FastApi项目启动失败 got an unexpected keyword argument ‘loop_factory‘
java·服务器·前端
咕噜咕噜啦啦2 小时前
Eclipse集成开发环境的使用
java·ide·eclipse
你的人类朋友4 小时前
【Node】认识一下Node.js 中的 VM 模块
前端·后端·node.js
光军oi5 小时前
全栈开发杂谈————关于websocket若干问题的大讨论
java·websocket·apache
weixin_419658315 小时前
Spring 的统一功能
java·后端·spring
小许学java6 小时前
Spring AI-流式编程
java·后端·spring·sse·spring ai
canonical_entropy6 小时前
对《DDD本质论》一文的解读
后端·架构·领域驱动设计
码事漫谈6 小时前
我用亲身经历告诉你,为什么程序员千万别不把英语当回事
后端
码事漫谈6 小时前
C++ const 用法全面总结与深度解析
后端
haogexiaole6 小时前
Java高并发常见架构、处理方式、api调优
java·开发语言·架构