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

生成文档形式

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

相关推荐
mldong5 小时前
引擎从不发一条消息:jeeflow 的两类扩展点与消息模块的分工
java·架构
君顾16 小时前
智慧零售实战指南:从技术架构到落地方案全解析
java·开发语言·零售
zhanghe6877 小时前
es的密码带有特殊字符,导出
java
pnoker7 小时前
IoT DC3 概念解读:把设备抽象成一套语义模板——位号、指令、事件与面向智能体的设备建模
java·人工智能·物联网·iot·dc3
my_realmy7 小时前
Java SE 基础学习笔记(一):面向对象、继承多态、抽象接口与异常(JDK 8)
java·多线程·并发··生产者消费者模式
天远数科7 小时前
风险治理实战:基于天远车信盟出险构建自动化理赔核保流水线
java·网络·人工智能·自动化
步行cgn7 小时前
YAML 的语法规则
spring boot·后端
骇客野人8 小时前
SpringBoot电商系统用户注册、登录、留存及数据埋点设计与落地实施方案
java·spring boot·后端
摇滚侠8 小时前
《SpringBoot 3:入门与应用实战》第 12 章 JDBC 与事务 数据库初始化机制 阅读笔记 36
数据库·spring boot·笔记
qiuhaipeng18 小时前
Claude code 升级后上下文长度变短问题
java·前端·数据库