在没有人工智能的时候,我们需要花费至少60分钟,阅读代码并根据自己的理解手动绘制思维导图或流程图,以帮助我们更好地理解代码。
这里面存在三个问题:
1、怎么通过AI解读代码
2、怎么通过流程图呈现解读后的代码?
3、怎么生成流程图
我将依次介绍这三部分
AI解读代码实际上利用了AI的总结能力,生成代码注释。大模型已实现此功能。
可能有的人会问,为什么不通过GPT直接生成注释呢?
这里介绍一个使用Comate解读代码的例子:
比如下面这段代码有200行,核心就是订单打包,比如10个订单聚类后生成8个包裹
聚类的细节太多,想着用AI提取并绘制流程图,更加直观,首先使用AI编程工具BaiduComate,解读这段代码
安装插件Comate后,在函数代码上方,找到代码解释菜单
点击代码注释,将会打开百度AI助手聊天框,显示代码解释
不论是给领导汇报,还是写周报,如果你能将的文字或者代码可视化,给人的感觉就立马不一样了,所以学会可视化非常重要
代码可视化一般需要创建UML图,这样的工具有很多,从使用文本描述来生成UML图的角度,我选择的是PlantUML
PlantUML是一个强大的工具,用于快速创建多种类型的图表。这些图表广泛用于软件开发和文档编写中,以下是PlantUML支持的一些主要图表类型:
2、用例图(UseCaseDiagram):描述系统的功能和外部用户(参与者)之间的交互。
3、类图(ClassDiagram):展示系统中类的结构和类之间的关系,如继承、接口实现、依赖关系等。
4、活动图(ActivityDiagram):类似于流程图,用于展示从一个活动到另一个活动的控制流。
5、组件图(ComponentDiagram):展示系统的组件如何组合在一起工作。
6、状态图(StateDiagram):展示一个对象在其生命周期内经历的状态以及状态间的转移。
7、对象图(ObjectDiagram):类图的一个实例,显示了系统中对象之间的关系。
8、包图(PackageDiagram):展示代码的包结构,有助于理解代码的模块化组织。
9、组织结构图(WireframeGraphicInterface):用于描述图形组织结构组成
不知道大家发现没有,好像没看到流程图,其实PlantUML中的活动图就是流程图,左边是代码语法,右边是可视化图形
我们通过AI编程工具生成了代码注释,然后将拿到的代码注释,询问AI:请基于下面这段代码注释,生成PlantUML活动图代码
看看AI的回复:
点击Submit按钮,就可以获取到图片了
看流程图就大概知道这段代码的含义了,AI解读代码可视化图,真的很方便
以上通过代码->注释->绘制流程图的方法,就得到了想要的效果,相比传统方式阅读完代码自己手动绘制图形,确实效率高了很多
比如基于上面的代码,我也可以生成类图
比如Go可重入锁,一张图解释通俗易懂
比如Go内存管理,一张图诠释内存分布组件
比如go.sum文件,一张图描述内部结构
比如sync.Cond底层数据结构,一张图说明提供的函数接口
上面的图都是使用AI生成的,AI可以让不懂编程的人,完成一个工具或者插件的开发,大大降低了软件开发的成本;AI可以让懂编程的人,更高效地完成日常工作,更快地完成应用开发,大大提高了工作和学习效率
我一直秉承一个观点:如果你不会写作,你也不会AI写作;如果你不会编程,你也不会AI编程。
如果想通过AI生成代码流程图,首先你得知道,什么是代码流程图,有哪些方式可以可视化,然后利用AI加速这个过程。