1. 1. 什么是 rustdoc?
  2. 2. 如何阅读 rustdoc 的输出
  3. 3. 如何写文档
  4. 4. 什么被包含(和排除)
  5. 5. 命令行参数
  6. 6. #[doc] 属性
  7. 7. 文档测试
  8. 8. 通过 items 名称链接
  9. 9. Lints
  10. 10. 高级特性
  11. 11. 不稳定特性
  12. 12. Website features
  13. 13. Passes
  14. 14. References

rustdoc 手册 中文版

References

有很多良好的 rustdoc 参考,如果你知道其他的好资源,请提交 PR!

官方

  • Learn Rust
  • Rust By Example
  • Rust Reference
  • RFC 1574: More API Documentation Conventions
  • RFC 1946: Intra Rustdoc Links

社区

  • API Guidelines
  • Github tagged RFCs
  • Github tagged issues
  • RFC (stalled) front page styleguide
  • Guide on how to write documentation for a Rust crate