rust 注释文档生成 cargo doc

2024-01-10 06:44:46

rust的cargo文档生成
只需要在每个函数写清楚注释，就可以自动生成文档，很方便
即不用写文档，又可以快速查看，是开发rust的必备技能

rust安装和开发环境配置，可以参考：链接

1.写注释的方法

连续三个 \ 即可，比如

/// 这是一个示例函数。
pub fn example_function(input: &str) {
    //省略具体的函数
}

2.自动生成文档

在项目目录的命令行中输入

cargo doc

第一次会先下载相关依赖，然后自动扫描项目，生成文档。
生成的时html文档，在

3.自动生成文档并用浏览器打开

如果需要生成文档后自动打开

cargo doc --open

4.查看文档

模块可以继续点下去，然后查看最后的函数
函数区域是main函数和第一页的那些个函数
上面的搜索框可以进行搜索

在这里插入图片描述

文章来源:https://blog.csdn.net/ziqibit/article/details/135433539
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。