#cargo-toml #文档 #功能 # #rustdoc

document-features

从 Cargo.toml 中的注释中提取功能标志的文档

11 个版本

0.2.10 2024 年 7 月 12 日
0.2.8 2023 年 12 月 29 日
0.2.7 2022 年 12 月 21 日
0.2.6 2022 年 9 月 24 日
0.2.1 2022 年 2 月 12 日

开发工具 中排名 100

Download history 44428/week @ 2024-05-01 46036/week @ 2024-05-08 51472/week @ 2024-05-15 57705/week @ 2024-05-22 55588/week @ 2024-05-29 54222/week @ 2024-06-05 63602/week @ 2024-06-12 64079/week @ 2024-06-19 66546/week @ 2024-06-26 77647/week @ 2024-07-03 86056/week @ 2024-07-10 95571/week @ 2024-07-17 98871/week @ 2024-07-24 144260/week @ 2024-07-31 150394/week @ 2024-08-07 129669/week @ 2024-08-14

每月下载量 540,184
用于 1,187 个 Crates(直接使用 254 个)

MIT/Apache

33KB
765 行(不含注释)

记录您的 Crates 功能标志

Crates.io Documentation

此 Crates 提供一个宏,用于从 Cargo.toml 中提取文档注释

要使用此 Crates,请在其文档中添加 #![doc = document_features::document_features!()]。该 document_features!() 宏读取您的 Cargo.toml 文件,提取功能注释并为您的文档生成 markdown 字符串。

在您的 Cargo.toml 中使用 ## #! 注释来记录功能,例如

[dependencies]
document-features = "0.2"
## ...

[features]
## The foo feature enables the `foo` functions
foo = []
## The bar feature enables the [`bar`] module
bar = []

#! ### Experimental features
#! The following features are experimental

## Activate the fusion reactor
fusion = []

这些注释将功能定义和文档放在一起,然后它们将被渲染到您的 Crates 文档中。

有关更多详细信息,请参阅 文档

贡献

欢迎贡献。我们接受拉取请求和错误报告。

许可证

MIT 或 Apache-2.0

依赖项

~170KB