2 个版本
0.1.1 | 2024 年 6 月 2 日 |
---|---|
0.1.0 | 2024 年 6 月 1 日 |
#813 在 Rust 模式
5KB
doxed
doxed 是一个使 Rust 文档字符串在运行时可用的小型包。
此包提供了一个 trait,Doxed
,可以为任何类型派生,使其文档字符串在运行时可用。文档字符串使用 #[doc = "..."]
属性或更常见的 Rust 文档注释 (///
) 来指定。
请注意,在派生 Doxed
时,文档字符串不会以任何方式修改。这保留了原始格式,包括前导空白和换行符。如果您想要对文档字符串进行任何处理,您可以在运行时轻松完成,而无需额外的派生魔法。
示例
use doxed::Doxed;
/// This is an example struct.
///
/// Multiple lines are supported.
#[doc = "So are manual doc attributes."]
#[derive(Doxed)]
struct Example<'a, T>(&'a T);
assert_eq!(Example::<()>::DOX, &[
" This is an example struct.",
"",
" Multiple lines are supported.",
"So are manual doc attributes."
]);
许可证: Apache-2.0
依赖关系
~105KB