如何生成＃[CFG（TEST）]背后模块的文档？

发布于 2025-01-31 22:38:17 字数 236 浏览 4 评论 0原文

在一个生锈项目中，有一个带有实用程序支持测试的模块，包装在模块test_utils中：

#[cfg(test)]
pub mod test_utils;

是否有一种方法来制作货物doc也生成的文档test_utils模块和内部的东西？

原文

In a Rust project there is a module with utilities to support testing, packed in a module test_utils:

#[cfg(test)]
pub mod test_utils;

Is there a way to make cargo doc generate also the documentation for test_utils module and the things inside?

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

柳絮泡泡 2025-02-07 22:38:17

可能有多种用于测试文档的方法，但是我认为更容易的方法是使用cargo Rustdoc生成文档，并传递-CFG Test通过：

cargo rustdoc -- --cfg test

There are probably multiple ways of generating documentation for tests, but I think the easier approach is to generate the documentation with cargo rustdoc and pass the --cfg test flag through:

cargo rustdoc -- --cfg test

回复收藏 0 原文

初见终念 2025-02-07 22:38:17

我刚刚发现这也有效：

#[cfg(any(test, doc))]
pub mod test_utils;

虽然文档是常规的

cargo doc

I just found that this works too:

#[cfg(any(test, doc))]
pub mod test_utils;

While documentation is generated with regular

cargo doc

回复收藏 0 原文

茶色山野 2025-02-07 22:38:17

我认为＃[CFG（ANY（test，doc））]可能还不够，它将在没有功能信息的情况下生成DOC。

/// The module should work
#[cfg(any(test, doc))]
pub mod test_utils {

    /// The function about test1
    #[test]
    fn test1() {
        assert!(true);
    }
}

为了与实用程序进行文档支持测试，也许[CFG_ATTR（非（doc），test）]是必要的。

/// The module should work
#[cfg(any(test, doc))]
pub mod test_utils {

    /// The function about test1
    #[cfg_attr(not(doc), test)]
    fn test1() {
        assert!(true);
    }
}

添加之后[CFG_ATTR（非（doc），test）]上面的测试用例：

I think #[cfg(any(test, doc))] is probably not enough, it will generate doc with no function information.

/// The module should work
#[cfg(any(test, doc))]
pub mod test_utils {

    /// The function about test1
    #[test]
    fn test1() {
        assert!(true);
    }
}

In order to doc with utilities to support testing, perhaps [cfg_attr(not(doc), test)] is necessary.

/// The module should work
#[cfg(any(test, doc))]
pub mod test_utils {

    /// The function about test1
    #[cfg_attr(not(doc), test)]
    fn test1() {
        assert!(true);
    }
}

After added [cfg_attr(not(doc), test)] above test cases: