是否有无证部分的警告？

Question

我正在写一个箱子，我打算发布。当发布时，最重要的事情之一（在我看来）是确保装箱的文档化。因此，我的问题是：是否有一个警告要被打开，以温暖未记录的代码部分？

---

比如: 我通常会想到这样的东西 #[warn(undocumented)].

Answer 1

是的，这样的提示是存在的。rustc编译器提供了 missing_docs 皮棉当启用时，它会警告公共项目的文档丢失。clippy linter提供了 missing_docs_on_private_items 皮棉它还警告说... ...嗯，你猜对了。请注意... missing_docs_in_private_items 警告所有的项目，所以你不需要再使用 missing_docs 如果您启用了它。

您可以使用

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

警告或

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

的错误。

Answer 2

您要找的是 遗失文件 皮棉 Rust编译器中。

例子。

#![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) {}
  | |___________________^
  |

你也可以找到 锈铁矿书中的更多棉絮.