#cfg #documentation #rustdoc

doc-cfg

#[doc_cfg(..)] 辅助属性

1 个不稳定版本

0.1.0 2019年2月22日

#2270开发工具

Download history • Rust 包仓库 44/week @ 2024-03-11 • Rust 包仓库 49/week @ 2024-03-18 • Rust 包仓库 42/week @ 2024-03-25 • Rust 包仓库 73/week @ 2024-04-01 • Rust 包仓库 68/week @ 2024-04-08 • Rust 包仓库 89/week @ 2024-04-15 • Rust 包仓库 172/week @ 2024-04-22 • Rust 包仓库 54/week @ 2024-04-29 • Rust 包仓库 48/week @ 2024-05-06 • Rust 包仓库 108/week @ 2024-05-13 • Rust 包仓库 106/week @ 2024-05-20 • Rust 包仓库 90/week @ 2024-05-27 • Rust 包仓库 47/week @ 2024-06-03 • Rust 包仓库 75/week @ 2024-06-10 • Rust 包仓库 48/week @ 2024-06-17 • Rust 包仓库 70/week @ 2024-06-24 • Rust 包仓库

每月下载 247
用于 10 个crate(直接使用 4 个)

MIT 许可证

14KB
220 代码行

doc-cfg

travis-badge release-badge docs-badge license-badge

#[doc_cfg(..)] 属性是一个方便的快捷方式,用于移除在稳定版crate中使用 #[doc(cfg(..))] 时所涉及的模板代码。

使用方法

要将以下内容添加到 Cargo.toml 中以开始使用

[dependencies]
doc-cfg = { version = "0.1" }

[features]
unstable-doc-cfg = []

[package.metadata.docs.rs]
features = ["unstable-doc-cfg"]

在您的crate中,使用 #[doc_cfg(..)],在您通常使用 #[cfg(..)] 的地方

#![cfg_attr(feature = "unstable-doc-cfg", feature(doc_cfg))]

use doc_cfg::doc_cfg;

#[doc_cfg(windows)]
pub fn cool_nonportable_fn() { }

功能名称很重要,不应更改。查看 使用示例。在编写文档时应仅启用 unstable-doc-cfg 功能,否则 #[doc_cfg(..)]#[cfg(..)] 无异。

文档

请参阅文档示例,获取最新使用信息。

依赖项

~315KB