rust - 如何在 `cargo doc`生成的文档中获取功能需求标签？

Question

如果您查看Tokio docs on docs.rs，则有一个蓝色标记，指示必须激活某个功能才能访问此API:

我也想为我的 crate 启用此功能，该怎么做？

Answer 1

坏消息是:目前这是每晚仅提供的功能。
好消息是:docs.rs默认情况下每晚使用。

要使此功能正常工作，您需要启用 doc_cfg feature并将#doc(cfg)应用于要记录的项目

#![feature(doc_cfg)]

#[doc(cfg(feature = "macros"))]
pub fn test() {}

由于这是仅每晚使用的功能，因此您可能不想一直启用它。 tokio在其 Cargo.toml中定义以下内容，以便仅在docs.rs上启用此功能:

# docs.rs-specific configuration
[package.metadata.docs.rs]
# document all features
all-features = true
# defines the configuration attribute `docsrs`
rustdoc-args = ["--cfg", "docsrs"]

然后他们使用

// only enables the `doc_cfg` feature when
// the `docsrs` configuration attribute is defined
#[cfg_attr(docsrs, feature(doc_cfg))]

#[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
pub fn test() {}