rust 注释文档生成 cargo doc

news/2024/6/17 16:32:50 标签: rust, 开发语言, 后端

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

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

1.写注释的方法

连续三个 \ 即可,比如

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

2.自动生成文档

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

rust">cargo doc

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

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

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

cargo doc --open

4.查看文档

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

在这里插入图片描述


http://www.niftyadmin.cn/n/5308746.html

相关文章

react渲染过程

一、渲染过程 渲染&#xff1a;生成用于显示的对象&#xff0c;以及将这些对象形成真实的DOM对象。 React元素&#xff1a;React Element&#xff0c;通过React.createElement创建&#xff08;语法糖&#xff1a;JSX&#xff09; 例如&#xff1a; <div>测试数据</di…

Django Auth登录实战

前言 目标&#xff1a;实现用户登录和注销功能。涉及django登录知识点&#xff0c;如登录的用户名密码如何验证&#xff0c;输出错误如何提示&#xff0c;当用户未登陆时访问功能页面如何让用户去登录&#xff08;DjangoAuth&#xff0c;类似过滤器&#xff09;等。 效果图 开…

关于“Python”的核心知识点整理大全65

目录 20.2.19 设置 SECRET_KEY 20.2.20 将项目从 Heroku 删除 注意 20.3 小结 附录 A 安装Python A.1.1 确定已安装的版本 A.1.2 在 Linux 系统中安装 Python 3 A.2 在 OS X 系统中安装 Python A.2.1 确定已安装的版本 A.2.2 使用 Homebrew 来安装 Python 3 注意 …

读元宇宙改变一切笔记01_起源

1. 元宇宙是我们下一个生存之地 1.1. 1968年&#xff0c;只有不到10%的美国家庭拥有彩色电视&#xff0c;但当年票房排名第二位的电影《2001&#xff1a;太空漫游》&#xff08;2001: A Space Odyssey&#xff09;设想了这样的未来 1.1.1. 斯坦利库布里克(Stanley Kubrick) …

c# OpenCvSharp透视矫正参数调整器

透视矫正不够智能化&#xff0c;每次都要进行局部参数调整&#xff0c;不便于程序使用&#xff0c;程序流程还是那几个步骤&#xff1b; 1、读取图像、灰度化 2、高斯滤波 3、二值化 4、边缘检测 灰度化图 上个图看看经过调整透视矫正边缘检测结果我还是挺满意的 发现一个…

贯穿设计模式-享元模式思考

写享元模式的时候&#xff0c;会想使用ConcurrentHashMap来保证并发&#xff0c;没有使用双重锁会不会有问题&#xff1f;但是在synchronize代码块里面需要尽量避免throw异常&#xff0c;希望有经验的同学能够给出解答&#xff1f; 1月6号补充&#xff1a;没有使用双重锁会有问…

【Python】Excel不同sheet另存为不同CSV

我有一个excel&#xff0c;内有不同sheet&#xff0c;现在批量生成不通csv文件&#xff0c;并以sheet名命名&#xff0c;或根据sheet名调整命名。 # 读取新的Excel文件 df pd.read_excel(rD:\itm\data.xlsx, sheet_nameNone)# 遍历每个sheet&#xff0c;将其另存为不同的CSV文…

在数据库造数据发现的bug也是bug

上个月&#xff0c;我和开发小哥讨论过一个问题&#xff0c;开发小哥专门提醒我&#xff0c;页面上新增功能尽可能在前端造一些数据去测试&#xff0c;如果直接从数据库里插入的数据&#xff0c;定位问题还是有些说不清楚。 讨论的过程和细节就是以下的对话内容&#xff1a; …