docgen  

Rust 库，用于动态文档化由宏创建的 Rust 项目。 在 docs.rs 上查看文档 这里.

许可证

本软件库在 MIT 许可证下作为开源软件提供。

lib.rs:

这个小巧的软件库允许开发者轻松地文档化宏中生成的项目，其中文档内容是动态的。

示例

#[macro_use]
extern crate docgen;

doc!(
    "Here is some documentation!"
    ""
    "Empty lines are represented by empty strings.";
    pub fn foo() {}
);

逗号可以用作行之间的分隔符

#[macro_use]
extern crate docgen;

doc!(
    "Here is some documentation!",
    "",
    "Empty lines are represented by empty strings.";
    pub fn foo() {}
);

这在文档化由宏创建的项目时尤其有用

#[macro_use]
extern crate docgen;

macro_rules! add_fn {
    ($name:ident, $ty:ty) => {
        doc!(
            concat!("Add two [`", stringify!($ty), "`] values together.");
            pub fn $name(a: $ty, b: $ty) -> $ty {
                a + b
            }
        );
    }
}

add_fn!(add_u8, u8);
add_fn!(add_i8, i8);