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

生成文档形式

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

相关推荐
许野平16 分钟前
Rust: 利用 chrono 库实现日期和字符串互相转换
开发语言·后端·rust·字符串·转换·日期·chrono
duration~31 分钟前
Maven随笔
java·maven
zmgst34 分钟前
canal1.1.7使用canal-adapter进行mysql同步数据
java·数据库·mysql
跃ZHD44 分钟前
前后端分离,Jackson,Long精度丢失
java
blammmp1 小时前
Java:数据结构-枚举
java·开发语言·数据结构
暗黑起源喵1 小时前
设计模式-工厂设计模式
java·开发语言·设计模式
WaaTong1 小时前
Java反射
java·开发语言·反射
齐 飞2 小时前
MongoDB笔记01-概念与安装
前端·数据库·笔记·后端·mongodb
狂放不羁霸2 小时前
idea | 搭建 SpringBoot 项目之配置 Maven
spring boot·maven·intellij-idea
九圣残炎2 小时前
【从零开始的LeetCode-算法】1456. 定长子串中元音的最大数目
java·算法·leetcode