rust - 对未记录的部分是否有警告？

Question

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

---

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

标签： rustwarningscompiler-warnings

Answer 1

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

您可以使用启用 lints

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

用于警告或

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

对于错误。