一、场景说明
在开发过程中开发人员在编程代码时或者在编程后,需要手动的去创建一个代码逻辑的思维导图进行说明代码的逻辑,在代码逻辑更改的时候,也需要同步去更新代码的逻辑思维导图,多做了一步维护思维导图的工作。这个插件就是能够通过IDEA插件,定义注解与指定格式的注释信息来获取到注解与注释中的内容,生成思维导图
二、使用说明
生成路径:
会在生成后进行弹窗提示让你选择保存的思维导图位置的文件夹
注解:
@FlowChart(""):定义在起始的方法的上面,用于定义方法是要进行生成思维导图解析的,如果方法没有这个注解,则IDEA的右键菜单中的 "生成思维导图" 不可用,需要注意,如果当前方法体中调用的别的方法中的也需要解析,则对调用的方法也需要使用这个注解
@FlowChild(""):定义在非起始方法的调用方法上,用于标识这个方法需要进行生成思维导图的处理,如果没有这个注解的方法,则不会进行分析注释与此方法内部调用方法的分析注释。
注释:
在注释信息中,使用 FLOW: 开头的则视为定义的节点信息,后面跟的文字则会被识别的节点
生成按钮在右键菜单中,使用时要选中生成的根节点的方法名再点击生成思维导图的菜单
三、最终成品展示
四、注意事项
1.方法的调用链只会去解析方法上有 @FlowChart 注解的方法,方法间的调用链中不能出现断层,例如通过方法A调用方法B,方法B又去调用方法C,流程信息写在方法C中,这时需要三个方法都需要设置上这个注解
2.因为插件中使用了注解,所以必须配套 flow-chart-jar 的jar包才可以
<dependency>
<groupId>com.github.ioexceptions</groupId>
<artifactId>flow-chart-java</artifactId>
<version>1.0.0</version>
</dependency>
五、增加配置项
1.增加IF是否分级的选项,想在思维导图对IF产生分级,则使用这个选项就可以实现了
2.选择导出主题,思维导图的常用主题设置,可以选择多个主题设置,显示各种效果,当导出的思维导图是展开状态时不方便查看,就可以选择 电子表格的主题进行选择
没有上架IDEA,有想要体验的可以用以下链接下载。
也可以到 Gitee 下载,有编译好的或者下载源码自己编译
flow-chart: IDEA通过解析代码中的注释来生成思维导图,让开发人员解放双手专注代码编程
升级日志:
2023-02-03
1.增加对接口实现类的注解解析,支持接口调用解析接口实现类方法中的注解生成思维导图
2.增加关联分组方式可以同时导出多个方法的思维导图
方法注解头部使用group并设置相同的值即可设置好关联,对任意一个设置好关联的方法执行导出思维导图就可以对所有相同group值的方法进行导出
最终效果展示:
3.修复在return中的方法调用无法检测到所调用方法的注解、注释信息的问题