Documentation 如何编写板条箱范围的文档？

为了确保我的板条箱的所有公共工件都有文档记录（如果从最低限度开始），我指定了

#！[拒绝（缺少文档）]

在my

lib.rs

中。这适得其反

我希望在顶部写一个文档注释，然后再写代码：

/// Hello world example for Rust.

#![deny(missing_docs)]

fn main() {
    println!("Hello world!");
}

这在以下情况下失败：

错误：外部文档注释后面不允许有内部属性
-->src/main.rs:3:3
|
3 | #![拒绝（缺少文档）]
|   ^
|
=注意：内部属性，如`#！[no_std]`，注释包含它们的项，通常位于源文件的开头。外部属性，如“#[test]”，对它们后面的项进行注释。

恢复顺序，使属性位于第一位，注释位于第二位：

#![deny(missing_docs)]

/// Hello world example for Rust.

fn main() {
    println!("Hello world!");
}

也未能：

错误：缺少板条箱的文档
-->src/main.rs:1:1
|
1 | / #![拒绝（缺少文档）]
2 | |
3 | |///Hello world锈蚀示例。
4 | |
5 | | fn main（）{
6 | | println！（“你好，世界！”）；
7 | | }
| |_^
|
注：此处定义了棉绒水平
-->src/main.rs:1:9
|
1 | #![拒绝（缺少文档）]
|         ^^^^^^^^^^^^

---

我找不到如何为板条箱本身编写文档。我应该如何编写板条箱的文档以满足

#！[deny（missing_docs）]

？

我在文件中找到了隐藏的金块

常规文档注释（以

//

开头）记录下一个项目，但板条箱不是下一个项目

解决方案是切换到使用另一种注释，这次从

//开始，用于记录随附项目

突然，它起了作用：

#![deny(missing_docs)]

//! Hello world example for Rust.

fn main() {
    println!("Hello world!");
}

这有点类似于属性的工作方式（尽管我先尝试了
//！
。@starblue：是的，当我意识到有一个
我发现与属性惊人的相似性；我认为这在代码示例中表现得很好，因为两者非常接近。