rust 注释文档生成 cargo doc

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

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

1.写注释的方法

连续三个 \ 即可,比如

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

2.自动生成文档

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

cargo doc

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

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

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

cargo doc --open

4.查看文档

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

在这里插入图片描述

相关推荐

  1. Rust 文档注释文件注释//!和函数、结构体注释///

    2024-01-07 01:28:02       101 阅读
  2. 快速了解 Rust 文档注释功能

    2024-01-07 01:28:02       31 阅读
  3. Rust 注释用法

    2024-01-07 01:28:02       49 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-01-07 01:28:02       98 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-01-07 01:28:02       106 阅读
  3. 在Django里面运行非项目文件

    2024-01-07 01:28:02       87 阅读
  4. Python语言-面向对象

    2024-01-07 01:28:02       96 阅读

热门阅读

  1. Elasticsearch(实践一)相似度方法L1、L2 、cos

    2024-01-07 01:28:02       57 阅读
  2. 探索Elasticsearch内存应用的关键因素

    2024-01-07 01:28:02       56 阅读
  3. C语言中的输入输出详解

    2024-01-07 01:28:02       66 阅读
  4. 第七节 按需导入elementPlus

    2024-01-07 01:28:02       62 阅读
  5. [数理统计]中国科技技术大学缪柏其

    2024-01-07 01:28:02       45 阅读
  6. 常见的深度相机品牌有哪些。

    2024-01-07 01:28:02       55 阅读
  7. 线特征_LSD直线检测算法和LBD直线描述子

    2024-01-07 01:28:02       61 阅读
  8. k8s之pod进阶

    2024-01-07 01:28:02       54 阅读