跳到主要内容

斜杠命令

优化代码​

💡使用方法​

以VSCode为例，目前CodeSouler支持以下几种方法进行代码的修复、优化和重构：

1. 选中代码块右击​

选中我们要注释的代码块，点击鼠标右键，在弹出的CodeSouler选项中选择"Fix this Code"以及"Optimize this Code"。当代码中存在划红线的问题代码需要处理时，可以选择"Fix this Code"让CodeSouler给出解决方案；当一些代码需要被优化时，则可以通过"Optimize this Code"对其进行重构，使其具备更高的健壮性和可读性。

2. 会话框撰写prompt​

选中指定代码块后，撰写prompt"请重构这段代码，确保代码的健壮性"，CodeSouler也可以实现代码的优化重构效果。

编写文档字符串​

💡使用方法​

以VSCode为例，目前该功能主要通过会话框中的/docstring操作符，实现对应代码块相应的文档字符串（包含函数的功能、参数、描述、可能抛出的异常）。 在CodeSouler会话框中使用@file指定文件进行/docstring,CodeSouler就会对整个代码文档每个组成部分生成相应的文档字符串

img

代码注释​

💡使用方法​

以VSCode为例，目前CodeSouler支持几种方法来为代码添加注释：

1.选中代码块右击​

选中我们要注释的代码块，点击鼠标右键，在弹出的CodeSouler选项中选择"Write Commenrts for this Code"，CodeSouler就会将注释实时嵌入到代码中，操作完毕后，您可以针对每一条注释选择接受/拒绝该修订，或选择接受/拒绝所有更改。

img

2.使用/comment操作符​

以VSCode为例，选中要注释的代码块，使用快捷键Crl + L(在JetBrain中为Ctrl + J)，CodeSouler即会弹出会话窗口。并将选中代码块引用到会话框中，然后输入/comment命令，即可返回代码注释。

img

3.会话框撰写prompt​

选中指定代码块后，直接撰写prompt"请为我撰写中文注释"，CodeSouler也可以实现添加注释的功能。

img

代码审查​

💡使用方法​

以VSCode为例，目前代码审查主要通过会话框中的/codereview操作符，实现对多种对象类型的代码审查。

1. 代码段​

选中某段代码段，使用快捷键Command + L / Ctrl + L将其添加到对话框上下文，输入/codereview，CodeSouler就会分析代码段内容并生成对应的审查报告和修改意见。

生成的修改意见可以直接点击右上角选项直接应用或插入到原代码中。

2. 指定文件​

在CodeSouler会话框中使用@file指定文件进行/codereview,CodeSouler就会对整个文件进行审查并给出修改意见。用户可针对每处修改给出接受或拒绝修订的操作。

3. 对Git diff进行CodeReview​

除了针对代码段和项目文件给出代码审查外，CodeSouler还支持对整个项目的修改(Git diff)给出代码审查意见，有针对性地评估修改内容，这个操作通过组合@Git diff 和/codereview即可快速实现。

安全扫描​

💡使用方法​

以VSCode为例，目前代码审查主要通过会话框中的/secscan操作符，实现对多种对象类型的代码审查。

1. 代码段​

选中某段代码段，使用快捷键Command + L / Ctrl + L将其添加到对话框上下文，输入/secscan，CodeSouler就会分析代码段内容并生成对应的审查报告和修改意见。

生成的修改意见可以直接点击右上角选项直接应用或插入到原代码中。

2. 指定文件​

在CodeSouler会话框中使用@file指定文件进行/secscan,CodeSouler就会对整个文件进行审查并给出修改意见。用户可针对每处修改给出接受或拒绝修订的操作。

生成测试用例​

💡使用方法​

以VSCode为例，目前该功能主要通过会话框中的/test操作符，为选定的代码块生成相应的测试用例。

选择某个具体功能的函数代码块,CodeSouler就会对选定的代码块生成相应的测试用例

Alt text