2.3 注释与文档

在 Rust 中,注释分为两类:普通注释和文档注释。普通注释使用 ///* ... */,文档注释使用 /////!/** ... **/

在原则和规则中提到「注释」时,包括普通注释和文档注释。当提到「文档」时,特指文档注释。

参考

  1. RFC 505: API 注释约定
  2. RFC 1574: API 文档约定
  3. Making Great Docs with Rustdoc
  4. Rust Doc book