导出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即可

生成文档形式

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

相关推荐
带刺的坐椅5 分钟前
轻量级流程编排框架,Solon Flow v3.5.0 发布
java·solon·workflow·flow·solon-flow
卡拉叽里呱啦21 分钟前
缓存-变更事件捕捉、更新策略、本地缓存和热key问题
分布式·后端·缓存
David爱编程25 分钟前
线程调度策略详解:时间片轮转 vs 优先级机制,面试常考!
java·后端
码事漫谈1 小时前
C++继承中的虚函数机制:从单继承到多继承的深度解析
后端
阿冲Runner1 小时前
创建一个生产可用的线程池
java·后端
写bug写bug1 小时前
你真的会用枚举吗
java·后端·设计模式
喵手2 小时前
如何利用Java的Stream API提高代码的简洁度和效率?
java·后端·java ee
-Xie-2 小时前
Maven(二)
java·开发语言·maven
掘金码甲哥2 小时前
全网最全的跨域资源共享CORS方案分析
后端
m0_480502642 小时前
Rust 入门 生命周期-next2 (十九)
开发语言·后端·rust