rsdoc

这个crate提供了一个过程宏，可以将文档注释中的PlandUML和Drawio图表转换为PNG或SVG图像。使用drawio将文档注释中的SVG图像作为UML图表。使用plantUML将文档注释中的PNG图像作为UML图表和流程图表。

需要Rust版本1.54或更高版本或等效的nightly版本。

https://raw.githubusercontent.com/cocalon/rsdoc/main/rsdoc_example.png

用法

将以下行添加到 Cargo.toml。

[dependencies]
rsdoc = "0.1.0"

plantuml!

使用 #[doc = plantuml!(...)] 将文档注释包装起来。使用 plantuml 代码块来编写UML图表。安装PlantUML插件后，您可以使用Alt+D键直接在源代码中浏览UML图表。

#[doc = rsdoc::plantuml!(
/// @startuml
/// !theme cyborg-outline
/// Bob -> Alice : hello
/// @enduml
)]
pub fn test_function(){}

plantuml_file!

或者您可以直接附加存储为文件的puml文件

#[doc = rsdoc::plantuml_file!(test.puml)]

如果您的文件位于项目目录下的文件夹中，您可以直接输入相对路径。

#[doc = rsdoc::plantuml_file!(pumls/test.puml)]

image!

如果您想附加图片，如PNG或SVG，可以这样操作

#[doc = rsdoc::image!(test.png)]

您也可以与Drawio工具一起使用它，希望您喜欢！

#[doc = rsdoc::image!(test.drawio.svg)]

如果您的文件位于项目目录下的文件夹中，您可以直接输入相对路径。

#[doc = rsdoc::image!(images/test.drawio.svg)]

提示

• 使用此宏会增加编译时间。可以使用 enable Cargo功能来关闭转换和大多数依赖包的编译。

许可证：MIT/Apache-2.0