对于未记录的部分是否有警告?

Question

我正在写一个我计划发布的板条箱。发布时，最重要的事情之一(在我看来(是确保板条箱有据可查。因此，我的问题：是否有要打开的警告来加热代码中未记录的部分？

---

例如：我通常会想到类似#[warn(undocumented)]。

Answer 1

是的，存在这样的棉绒。rustc 编译器提供了missing_docslint，该 lint 在启用时警告公共项缺少文档。剪短绒提供missing_docs_in_private_items绒毛，另外警告...好吧，你猜对了。请注意，missing_docs_in_private_items会针对所有项目发出警告，因此如果启用它，则不需要missing_docs。

您可以使用以下方法启用棉絮

#![warn(missing_docs)]
#![warn(clippy::missing_docs_in_private_items)]

对于警告或

#![deny(missing_docs)]
#![deny(clippy::missing_docs_in_private_items)]

对于错误。

Answer 2

您正在寻找 Rust 编译器中缺少的文档lint。

例：

#![warn(missing_docs)]
fn foo(bar: i32) {}

编译器的输出：

warning: missing documentation for crate
--> src/lib.rs:1:1
|
1 | / #![warn(missing_docs)]
2 | |
3 | | fn foo(bar: i32) {}
| |___________________^
|

您还可以在 rustc 书中找到更多棉绒。