rust - 有没有办法在 rustdoc 中嵌入序列图？

Question

正如他们所说，一张照片值 1000 字。我想sequence diagrams在我生成的rust documentation. 有没有办法做到这一点？拥有一个embedded image并没有真正起作用，它更难维护，它是文档之外的资产，等等。

score 3 · Accepted Answer

最通用的方法只是非代码代码块中的基于文本的图表。

/// This module contains structs and functions for communicating to and from
/// the server. It is very important that you understand this diagram so you
/// will appreciate how much work has gone into this. Just look at it! Its
/// beautiful!
/// 
/// ```none
/// +------------+          +------------+
/// |   Client   |          |   Server   |
/// +------------+          +------------+
///       |                        |
///       | request("/")           |
///       +----------------------> |
///       |                        |
///       |             response() |
///       | <----------------------+
///       |                        |
///       |                        |
///       v                        v
/// ```
/// 
/// Appreciating the diagram will give you a +1 to confidence for the rest of
/// the day.
pub mod connection {

}

最终会像这样渲染：