talsma-ict/umldoclet
GitHub: talsma-ict/umldoclet
一个基于 Javadoc 的 Doclet 插件，用于在 Java 文档中自动生成并嵌入 PlantUML 格式的 UML 类图、包图和依赖图。
Stars: 255 | Forks: 35
[][maven]
[][javadoc]
[](https://sonarcloud.io/summary/new_code?id=talsma-ict_umldoclet)
[][coveralls]
# UMLDoclet
[Doclet for javadoc][doclet] 用来自动将 [UML diagrams][plantuml] 添加到 Java 文档中。
## 生成 UML 图
UML Doclet 使用可用的 javadoc 元数据自动生成
以下 UML 图，并将它们嵌入到您的 HTML 文档中。
默认情况下，这些图会作为可点击的 SVG 对象嵌入，
并在可用时链接到包和类的文档。
### 包依赖图
_UML Doclet 会警告（并可选地在出现时中断）循环包依赖。_
依赖图链接到包含以下内容的包文档：
### 包图
包图链接到包含以下内容的类文档：
### 类图
（这些示例取自[最新的 UML Doclet javadoc][javadoc] 页面。欢迎前往查看，以了解最终生成的效果）
## 环境要求
要使用 UML Doclet，需要满足以下条件。
- [Javadoc version 9][doclet] 或更高版本。
对于来自较早 JDK 的 javadoc 版本，请使用[最新的 `1.x` UML Doclet 版本][v1.x]。
如果您使用较新的 JDK（Javadoc version 9 或更高版本）编译 Java 8 或更早版本的 javadoc，
您需要使用 2.x 版本。
- UML Doclet，[使用页面][usage] 展示了具体方法。
umldoclet jar 中已经包含了采用 Apache 许可证的 [PlantUML][plantuml] 版本。
## 发布版本
已发布的版本可以在 [maven central repository][maven]
或 [github](https://github.com/talsma-ict/umldoclet/releases) 上找到。
## 用法
- 关于如何在您自己的 Java 项目中使用 UML Doclet，
请参阅单独的 [使用页面][Usage]。
## 反馈
- 我们欢迎[新 issue](https://github.com/talsma-ict/umldoclet/issues/new)。
请搜索[当前的 issue](https://github.com/talsma-ict/umldoclet/issues)
以避免提交重复内容。
- 如果可能的话，请在提交 bug 时提供示例。
这将使修复工作变得更加容易！
## 致谢
- 首先要特别感谢 [Arnaud Roques](https://github.com/arnaudroques)，
他是优秀的 [PlantUML 项目](https://github.com/plantuml/plantuml) 的开发者，
没有他，这个项目就不会存在！
- 当然，也要感谢_您_使用 UML Doclet。
希望它能为您的项目带来帮助！
## 许可证
- [Apache 2.0 license](./LICENSE)
标签：Javadoc, JS文件枚举, PlantUML, SOC Prime, 代码可视化, 域名枚举, 开发工具