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