Rust 如何在“cargo doc”生成的文档中获取功能需求标签?
如果您查看,则有一个蓝色标记指示必须激活某个功能才能访问此API:Rust 如何在“cargo doc”生成的文档中获取功能需求标签?,rust,rustdoc,Rust,Rustdoc,如果您查看,则有一个蓝色标记指示必须激活某个功能才能访问此API: 我也想为我的板条箱启用此功能,如何做到这一点?坏消息是:这是目前唯一的夜间功能 好消息是:默认情况下,docs.rs使用nightly 要使其正常工作,您只需启用并将#doc(cfg)应用于要记录的项目 #![feature(doc_cfg)] #[doc(cfg(feature = "macros"))] pub fn test() {} 因为这是一个只在夜间使用的功能,所以您可能不想一直启用它t
我也想为我的板条箱启用此功能,如何做到这一点?坏消息是:这是目前唯一的夜间功能 好消息是:默认情况下,docs.rs使用nightly
要使其正常工作,您只需启用并将
#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"]
然后他们使用
//仅在以下情况下启用“doc\u cfg”功能
//已定义“docsrs”配置属性
#[cfg_attr(docsrs,feature(doc_cfg))]
#[cfg_attr(docsrs,doc(cfg(feature=“macros”))]
pub fn test(){}
要在本地进行测试,请使用:RUSTDOCFLAGS=“--cfg docsrs”货物+夜间文件--所有功能