ishangsf/workflows
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: improve comments workflow guide.

Browse Source
This commit is contained in:
Rankin Zheng 2024-04-02 10:17:25 +08:00
parent b66cfc9a4f
commit ddc236f297
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
comments/README.md
View File

@ -1,13 +1,12 @@
需要输入参数，使用指南如下：
### 操作指南
## 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)
生成行间注释，请按照如下步骤操作：
1. 选中行间代码。
2. 输入\/comments，回车发送；或右键点击**DevChat: Generate Comments**按钮。
3. 开始生成行间注释，等待生成结束。
4. 自动弹出Diff View，选择是否接受修改。
如图所示：
![图片](https://deploy-script.merico.cn/devchat/workflow/readme_comments.gif)