rust 注释文档生成 cargo doc

news2024/10/3 4:34:47

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

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

1.写注释的方法

连续三个 \ 即可,比如

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

2.自动生成文档

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

cargo doc

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

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

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

cargo doc --open

4.查看文档

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

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1362102.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

如何计算CAN通信波特率

目录 1、理论 2、实践 3、注意事项 在CAN总线系统中,波特率的计算是一个关键步骤,它确保网络上的所有设备能够以相同的速率进行通信。 1、理论 波特率的计算涉及到几个关键参数,包括CAN控制器的时钟频率、分频因子、以及位时间的不同部分…

es集群安装及优化

es主节点 192.168.23.100 es节点 192.168.23.101 192.168.23.102 1.安装主节点 1.去官网下载es的yum包 官网下载地址 https://www.elastic.co/cn/downloads/elasticsearch 根据自己的需要下载对应的包 2.下载好之后把所有的包都传到从节点上,安装 [rootlocalho…

我在 VSCode 插件里接入了 ChatGPT,从此代码写的如诗一样

编程是一门艺术,代码是程序员的诗篇。那么,如果我们能够让代码写作变得更加优雅、高效,甚至如诗一样流畅呢? 最近,我在我的 VSCode 编辑器中集成了 ChatGPT 插件,这个改变彻底提升了我的编程体验。在这篇博…

使用docker安装mysql 8.0

打开命令行,运行 ocker pull mysql:8.0.21 下载成功后,可以看到 进入cmd,输入 docker run -d --name mysql -p 3306:3306 -v /root/mysql/data:/var/lib/mysql -v /root/mysql/config:/etc/mysql/conf.d -e MYSQL_ROOT_PASSWORDabc12345…

5.vue学习笔记(数组变化的侦测+计算属性+Class绑定)

文章目录 1.数组变化的侦测1.1.变更方法1.2.替换一个数组 2.计算属性计算属性缓存vs方法 3.Class绑定3.1.绑定对象3.2.多个对象的绑定形式3.3.绑定数组3.4.数组与对象 1.数组变化的侦测 1.1.变更方法 vue能够侦听响应式数组的变更方法,并在它们被调用时出发相关的…

opencv003图像裁剪(应用NumPy矩阵的切片)

这一部分相对于马上要学习的二值化是要更更更简单一些的,只需三行,便能在opencv上裁剪图像啦(顺便云吸猫,太可爱了!) 出处见水印! 1、复习图像的显示 前几天期末考试,太久没有看…

大语言模型LLM微调技术:Prompt Tuning

1 预训练语言模型概述 1.1 预训练语言模型的发展历程 截止23年3月底,语言模型发展走过了三个阶段: 第一阶段 :设计一系列的自监督训练目标(MLM、NSP等),设计新颖的模型架构(Transformer&#…

Windows下MongoDB启动及停止服务

1.CMD黑窗口输入启动命令: net start MongoDB 2.CMD黑窗口输入停止命令: net stop MongoDB

算法第十二天-矩形区域不超过K的最大数值和

矩形区域不超过K的最大数值和 题目要求 解题思路 来自[宫水三叶] 从题面来看显然是一道[二维前缀和]的题目。本题预处理前缀和的复杂度为O(m* n) 搜索所有子矩阵需要枚举[矩形左上角]和[矩形右下角],复杂度是 O ( m 2 ∗ n 2 ) O(m^2 * n^2) O(m2∗n2)&#xff0c…

GPT/GPT4科研应用与AI绘图技术及论文高效写作教程

详情点击链接:GPT/GPT4科研实践应用与AI绘图技术及论文高效写作教程 一OpenAI 1.最新大模型GPT-4 Turbo 2.最新发布的高级数据分析,AI画图,图像识别,文档API 3.GPT Store 4.从0到1创建自己的GPT应用 5. 模型Gemini以及大模型…

华媒舍:国内外媒体发稿点爆品牌提高影响力

在数字经济时代,品牌营销推广越来越尤为重要。而国内外媒体宣发就成为了促进品牌提高的重要引擎。本文将对危害品牌提高的影响因素开展科谱详细介绍。 一、媒体宣发:品牌营销推广的重要途径媒体宣发是指通过各种媒体网络资源,根据报导、视频等…

常用的窗体控件

常用窗体控件 MenuStrip:一个标准的菜单栏控件,可以添加菜单单项和子菜单项 //双击子菜单项同样可以添加点击事件 //menu:菜单 item:菜单选项 //当点击新建选项的时候触发的事件 private void 新建ToolStripMenuItem_Click(ob…

Docker 镜像以及镜像分层

Docker 镜像以及镜像分层 1 什么是镜像2 Docker镜像加载原理2.1 UnionFs:联合文件系统2.2 Docker镜像加载原理2.3 Docker镜像的特点 3 镜像的分层结构4 可写的容器层 1 什么是镜像 镜像是一种轻量级、可执行的独立软件包,用来打包软件运行环境和基于运行…

玩转Mysql 三(权限管理)

一路走来,所有遇到的人,帮助过我的、伤害过我的都是朋友,没有一个是敌人。 一、用户管理 1、登录MySQL服务器 语法示例: mysql –h hostname|hostIP –P port –u username –p DatabaseName –e "SQL语句" 详细命令…

【LeetCode:2807. 在链表中插入最大公约数 | 链表】

🚀 算法题 🚀 🌲 算法刷题专栏 | 面试必备算法 | 面试高频算法 🍀 🌲 越难的东西,越要努力坚持,因为它具有很高的价值,算法就是这样✨ 🌲 作者简介:硕风和炜,…

响应式开发

响应式开发的原理Bootstrap前端开发框架Bootstrap栅格系统阿里百秀首页案例 响应式开发原理 1 响应式需要一个父级做为布局容器,来配合子级元素来实现变化效果。 2 在不同屏幕下,通过媒体查询来改变这个布局容器的大小,再改变里面子元素的排…

MySQL之视图内连接、外连接、子查询

一、视图 1.1 含义 虚拟表,和普通表一样使用 视图(view)是一个虚拟表,其内容由查询定义。同真实的表一样,视图包含一系列带有名称的列和行数据。但是,数据库中只存放了视图的定义,而并没有存放…

PEFT: 在低资源硬件上对十亿规模模型进行参数高效微调

1 引言 最近,深度学习的研究中出现了许多大型预训练模型,例如 GPT-3、BERT 等,这些模型可以在多种自然语言处理任务中取得优异的性能表现。而其中,ChatGPT 模型因为在对话生成方面的表现而备受瞩目,成为了自然语言处理…

JavaWeb 页面上显示中文乱码解决~

你们好,我是金金金。 场景 我正在学习servlet,通过write()方法向页面上写入中文数据,没想到显示的都是?? 乱码,如图 排查 很明显可以看出来页面上显示的是??,我猜想肯定是字符编码的问题,导致乱码 造成…

Mybatis分页插件PageHelper的配置和使用

文章目录 每页10条记录,取第一页,返回的是前10条记录每页10条记录,取第二页,返回的是第11条记录,到第20条记录, MySQL对分页的支持 简单来说MySQL对分页的支持是通过limit子句。请看下面的例子。 limit关键…