我正在用 Rust 编写我的第一个二进制 crate,虽然我对所有函数都有文档注释,但运行后没有一个函数出现在文档中cargo doc --no-deps
。我在文档中看到的唯一条目是我的箱子的名称,其中一行//!
以我的评论开头。
但是,当我将模块标记为公开时,它们确实会出现。所以在我的 main.rs 中,而不是
mod tasks;
如果我使用
pub mod tasks;
这些模块与它们的公共功能一起出现。
我发现我还需要为我的main
函数执行此操作,之后它会在文档中列出。我不确定我是否应该这样做。
我做对了吗?