16-生成和查看文档

3.5.2　生成和查看文档

要生成文档，我们可以在项目目录中使用cargo doc命令。它使用一堆HTML文件和预定义的样式表在target/doc/目录中生成文档。默认情况下，它也会为软件包的依赖项生成文档。我们可以通过运行cargo doc --no-deps命令告诉Cargo忽略生成依赖项的文档。

要查看文档，可以通过导航到target/doc目录下生成HTTP服务器来实现。Python的简单HTTP服务器在这里可以派上用场。但是，还有一个更好的办法来做到这一点，如将--open参数传递给cargo doc命令将会在用户默认的浏览器中打开文档页面。

提示

可以将cargo doc与cargo watch搭配使用，以获得无缝编写文档的体验，并在生成的页面上获得对项目中任何文档更改的实时反馈。