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

生成文档形式

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

相关推荐
Wang's Blog8 分钟前
Java 项目实战: 交友项目 - JWT 概述:为什么要用 Token 换掉 Session
java·ui·交友
SL_staff1 小时前
低代码选型避坑指南:为什么‘能拖拽’不等于‘能交付’?——基于JVS八大引擎的四维交付能力评估框架
java·低代码·spring cloud
李福春1 小时前
技术思考问题6:技术演讲该晒成功架构,还是交代失败与取舍?
java·开发语言·架构·computer use·深圳同盟·腾讯云架构师技术同盟·反演思维
Nturmoils1 小时前
本来只想给内网开个口子,Natapp 却多给了一道防护
后端
136096757231 小时前
静态统计 SQL 时必须连 DELETE 一起看
后端
WILLF1 小时前
《从0搭建AI聊天后端:FastAPI+OpenAI+SSE流式输出》
人工智能·后端
用户7771298509121 小时前
equals和==的区别
java
旋律4142 小时前
对封装、继承、多态三个概念理解
java