文档提示

为确保记录所有可能的项目,你可以使用 missing_docs 链接从编译器接收警告/错误。要在库范围内接收警告,请将此属性放在 lib.rs 文件中:

#![warn(missing_docs)]

你还可以使用此 lint 接收缺少文档的错误:

#![deny(missing_docs)]

默认情况下,允许使用 missing_docs,但你可以使用以下属性明确允许它们:

#![allow(missing_docs)]

这可能有助于放置在一个模块中以允许缺少一个模块的文档,但在所有其他文件中拒绝它。