本文主要是介绍rust 注释文档生成 cargo doc，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！
rust的cargo文档生成
只需要在每个函数写清楚注释，就可以自动生成文档，很方便
即不用写文档，又可以快速查看，是开发rust的必备技能
rust安装和开发环境配置，可以参考：链接
1.写注释的方法
连续三个 \ 即可，比如
/// 这是一个示例函数。
pub fn example_function(input: &str) {//省略具体的函数
}
2.自动生成文档
在项目目录的命令行中输入
cargo doc
第一次会先下载相关依赖，然后自动扫描项目，生成文档。
生成的时html文档，在
3.自动生成文档并用浏览器打开
如果需要生成文档后自动打开
cargo doc --open
4.查看文档
模块可以继续点下去，然后查看最后的函数
函数区域是main函数和第一页的那些个函数
上面的搜索框可以进行搜索
这篇关于rust 注释文档生成 cargo doc的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！
