我希望能够在生成的箱子页面上添加文档注释。例如,this page表明,在crate
标题下,下面列出了常规注释,这些注释与在特定Rust语法上方进行的markdown注释相同。
如果执行以下操作,则可以在模块上进行注释并生成它:
lib.rs:
/// This module contains functions and car objects.
/// # Examples
/// Here is an example
/// ```rust
/// use biz::cars::Honda;
/// let car = Honda::new();
/// ```
pub mod cars;
即使程序包中有README.md并将其列出在Cargo.toml
中,cargo doc
也不会使用它。