name: rust-docs-guidelines description: Rust文档编写指南
Rust文档指南
编写Rust文档时应遵循的标准。
指南
- 关键概念应只解释一次。所有其他文档应使用内部文档链接指向首次解释。
- 当提及Rust符号（类型、函数、常量等）时，始终使用内部文档链接。
- 避免引用特定的行号或行范围，因为它们可能会随时间变化。 如果文档需要附加到函数/方法体内的特定代码部分，请使用行注释。
- 关注为什么，而不是如何。 特别是，避免在线注释中解释琐碎的实现细节。
- 使用内部文档链接引用常量。不要在其它项目的文档中硬编码它们的值。
- 优先使用内部文档链接到私有项目，而不是重复。在相关处添加
#[allow(rustdoc::private_intra_doc_links)]。