📝 前言
作为一名程序员、博客文章书写者、学术垃圾制造者,总是要根据代码绘制程序流程图,然后转化为文字叙述,这着实让我苦恼。流程图不就是复制代码注释,然后根据程序进行流程图绘制就可以了嘛。为了不想再次文字叙述流程图,还是借助AI工具。特此将笔记分享给大家!
一、示例方法步骤
1、给AI源代码,并根据指令生成Flowchart流程图代码
命令:**
根据我给的代码,给出 【XXXXXXXX】无线通信模块子程序设计的逻辑和步骤,代码如下:
**
2、根据Ai给出的程序设计逻辑和步骤,生成Flowchart流程图代码
在能识别MarkDowm语法的软件中,填入代码生成Flowchart流程图
3、代码生成Flowchart流程图
3.1 代码转化为文字叙述
命令:
根据我给的程序设计逻辑,给出 【XXXXXXXX】模块子程序设计的MarkDown语法的
**
Flowchart流程图代码程序设计逻辑
**
如下:
AI****生成内容
3.2 文字转化的marmaid流程图代码
命令:这是一段【XXXX】源代码,你需要根据源代码生成专业的Mermaid流程图代码:
3.3 使用MarkDown绘图软件,插入代码绘图
最终代码结果
4、 语法备注
(1)内容中的、语法不能正确识别,用‘,’分隔。
(2)基础语法识别,符号,边框,内容,条件语句 。
二、流程图代码示例
1、流程图代码示例
1.1 Flowchart语法代码
flowchart TB
A([颜色传感器初始化])
B[调用Color_Sensor_Init函数]
C[配置I2C总线GPIO引脚]
D[设置传感器的工作模式、采样率、增益等参数]
E[自定义配置传感器的阈值、滤波器、校准参数]
F[检查传感器是否正常响应、配置是否成功]
G([返回配置结果])
A --> B
B --> C
C --> D
D --> E
E --> F
F --> G
1.2 代码生成流程图
三、工具介绍
1、 Ai工具
- 文心一言(百度)
- 阿水AI(聚合性付费AI)
- 通义千问(阿里产品)
- OpenAi-charGPT(需要科学)
- 智谱(强烈推荐)
- 秘塔AI(信息网络检索归纳,写文章,论文推荐使用)
2、支持MarkDowm语法的工具或者网站
(1)“有道云笔记”的MarkDowm文件
(2)CSDN的博客网页,发布文章,选择MarkDown笔记编辑
(3)使用PC段的Typora软件
软件下载网址:链接:https://pan.baidu.com/s/1s4-EfuBFGUPpExJ_FWH3ng?pwd=jpjp
四、mermaid语法学习网址推荐
(1)国内CSDN语法:https://blog.csdn.net/qq_63585949/article/details/131544942
(2)官网Flowchart:****Flowcharts Syntax | Mermaid
五、汇总Ai复杂命令示例
(1)
根据我给的代码,给出 【XXXXXXXX】模块子程序设计的逻辑和步骤,代码如下:
(2)文心一言使用:这是一段【XXXXXXXXXX】的源代码,你需要根据源代码生成专业的Mermaid流程图代码。源代码如下:......
(3)文字转换流程图示例
将我之后要求的文字转换为Flowchart流程图代码。
文字转换内容如下:
【XXXXXXXXXXXXXXXX】
代码要求:
- 用字母来标记每个步骤;
- A第一个和最后一个节点呈现为圆行,其他节点呈现为长方形;
- 输出为使用mermaid语法编写的Flowchart流程图代码。
示例参考:
用户输入:单次读取I2C数据:Single_ReadI2C 函数通过调用I2C总线相关函数,如发送起始信号、写入读取命令、等待应答、读取数据、发送停止信号,实现一次从传感器读取数据的操作。读取到的数据存储在 data 变量中,通过函数返回值指示读取操作是否成功。单次读取I2C数据流程:
- 调用Single_ReadI2C函数
- 定义变量data,用于存储读取数据
- 发送起始信号,开始一次读取操作
- 发送读取命令,等待传感器应答
- 读取传感器发送的数据,存储到data变量中
- 发送停止信号,结束读取操作
- 返回读取到的数据或错误代码
(4)文字转换流程图示例2
现在根据以下文字转化为流程图。XXXX子程序设计:具体程序设计流程如下:
/************************************ 修改成自己需要的代码解释 *********************
- 在函数read_lin_dev()中,首先定义了一个指向modbus_reg_t结构体的指针reg,该结构体用于保存LIN设备的版本号信息。
- 随后,通过一个循环遍历LIN设备列表LIN_DEV_LIST,对每个设备进行操作。在循环中,首先调用sendtest()函数,以LIN设备的硬件版本号作为参数,并指定hard_flag为true。sendtest()函数会发送一系列数据帧给LIN设备,其中包括命令和数据,并等待接收设备的响应。如果成功接收到响应,则将LIN设备的硬件版本号存储到reg->lin_dev[i].hard_version中;如果未成功接收到响应,则将LIN设备的硬件版本号同样存储到reg->lin_dev[i].hard_version中。
- 接着,通过一个延时函数delay_Xms()延时一段时间,以确保与LIN设备的通信稳定。
- 随后,再次调用sendtest()函数,以LIN设备的软件版本号作为参数,并指定hard_flag为false。同样,如果成功接收到响应,则将LIN设备的软件版本号存储到reg->lin_dev[i].soft_version中;如果未成功接收到响应,则将LIN设备的软件版本号同样存储到reg->lin_dev[i].soft_version中。最后,函数返回true表示读取LIN设备的版本号成功。
通过以上的逻辑,可以实现对LIN设备的版本号读取,并保存到相应的数据结构中,以供数据传输到上位机,进行数据的使用和显示。
************************************ 修改成自己需要的代码解释 *********************/
📝 归纳总结
以上就是我利用AI工具将程序逻辑图转化为专业的文字叙述的方法。通过这种方式,我们在编写文章时可以减少文字叙述的时间,将更多的时间投入到思考和创作中。除了上述提到的操作步骤和AI命令脚本,我们还可以尝试其他的OCR文字识别工具和AI工具,去发掘更多的高效率的方法。希望本篇笔记能够对大家有所启发和帮助!
版权归原作者 不想脱发的基兄 所有, 如有侵权,请联系我们删除。