14-文档

3.5　文档

文档是任何旨在被程序员社区广泛采用的、开源软件的一个非常重要的东西。若你的代码是可读的，则能够告诉用户它的工作原理，但是文档应该告诉用户软件设计决策的原因和方式，以及公共API的示例用法。文档化良好的代码和介绍全面的README.md页面可以大大提高项目的可发现性。

Rust社区非常重视文档，并提供各种级别的工具，以便编写代码文档。它对用户也非常友好，生成的文档简洁、美观。对于编写文档，它支持markdown。markdown是一种非常流行的标记语言，是现在编写文档的标准。Rust有一个名为rustdoc的专用工具，可以解析markdown的文档注释，将它们转换成超文本标记语言（HyperText Markup Language，HTML）格式，并生成精美且可搜索的文档页面。