macro_railroad 注释

用于生成 macro_rules! 的铁路图并将其嵌入文档的注释宏

用法

/// This is some documentation for the macro below
#[macro_railroad_annotation::generate_railroad]
/// # Examples
/// ````ignore
/// foo!(5 + 5);
/// ````
macro_rules! foo {
  ($tok:expr) => {};
}

请注意，这仅在夜间编译器（包括 docs.rs）上正确定位图形。如果在稳定版本上，图形将仅定位在文档注释的顶部。alt 文本将设置为以下横幅

=========================================================
_Here would be a railroad diagram of the macro [`macro_name`]_
=========================================================

或者，您可以手动定位图像并指定自己的 alt 文本，这在所有版本上都有效

/// This is some documentation for the macro below
/// ![alt text][ref_string]
/// # Examples
/// ````ignore
/// foo!(5 + 5);
/// ````
#[macro_railroad_annotation::generate_railroad("ref_string")]
macro_rules! foo {
  ($tok:expr) => {};
}

致谢

此宏使用优秀的 macro_railroad 库生成图表，并且只是对该库的精简封装。