feat: add more readme file

This commit is contained in:
Rankin Zheng 2024-03-30 00:39:47 +08:00
parent e9cac56372
commit ad4c2310d3
3 changed files with 31 additions and 0 deletions

13
comments/README.md Normal file
View File

@ -0,0 +1,13 @@
需要输入参数,使用指南如下:
## 1.选中代码
选中你需要注释的代码,右键唤出菜单,点击"DevChat: Generate Comments"向AI助手发起求。或者在DevChat聊天窗口键入/comments 直接发起行间注释工作流。
![图片](https://deploy-script.merico.cn/devchat/workflow/comments_1.png)
![图片](https://deploy-script.merico.cn/devchat/workflow/comments_2.png)
## 2.生成注释
等待结果,而后进行差异比对。
![图片](https://deploy-script.merico.cn/devchat/workflow/comments_3.gif)
## 3.比对差异
生成结束后,工作流会自动调用差异比对界面。你可以看到注释代码的差异,接受他们或者逐行比对。
![图片](https://deploy-script.merico.cn/devchat/workflow/comments_4.png)

17
fix/README.md Normal file
View File

@ -0,0 +1,17 @@
需要输入参数,使用指南如下:
## 1.选中代码
选中你需要纠错的代码右键唤出菜单点击“DevChatFix this”。或者在 DevChat 聊天窗口,键入/fix 直接发起代码纠错工作流。
![图片](https://deploy-script.merico.cn/devchat/workflow/fix_1.png)
## 2.分析代码
开始生成以后AI 会根据选中的代码,对命名规范、代码格式、逻辑错误等给出自己的优化意见。生成结束以后,还会调用 DevChat 的差异比对界面,方便用户查看修改点。
![图片](https://deploy-script.merico.cn/devchat/workflow/fix_2.gif)
## 3.比对差异
在差异对比界面,您可以点击 DevChat 图标接受修改,或者逐行查看变更。
![图片](https://deploy-script.merico.cn/devchat/workflow/fix_3.png)

View File

@ -1,3 +1,4 @@
需要输入参数,使用指南如下:
## 1.选中代码