Merge pull request #130 from devchat-ai/update_readme

Update README

merico/aider/README.md

@@ -1,19 +1,25 @@
-### 操作指南
+### aider 操作指南
 
-aider工作流命令使用步骤如下：
+aider是一个AI辅助的代码编辑工具,可以根据自然语言指令修改代码。
 
-1. 确保已经使用 `/aider.files.add` 命令添加了需要处理的文件。
-2. 输入 `/aider <message>` 命令，其中 `<message>` 是你想要aider执行的任务描述。
-3. 等待aider生成建议的更改。
-4. 系统会自动显示每个文件的Diff View，你可以选择是否接受修改。
-5. 对于多个文件的更改，系统会在每个文件之后询问是否继续查看下一个文件的更改。
+用途:
+根据用户提供的指令,自动分析和修改已添加到aider中的代码文件。
 
-注意事项：
-- 如果没有添加任何文件到aider，命令将会提示你先使用 'aider.files.add' 命令添加文件。
-- 你可以使用 `aider.files.remove` 命令从aider中移除文件。
-- 所有的更改都会在IDE中以Diff View的形式展示，你可以在查看后决定是否应用这些更改。
+使用方法:
+1. 使用 `/aider.files.add` 命令添加需要处理的文件
+2. 输入 `/aider <message>` 命令,其中 `<message>` 是你想要aider执行的任务描述
+3. 等待aider生成建议的更改
+4. 在IDE中查看每个文件的Diff视图,选择是否接受修改
+5. 对于多个文件的更改,系统会在每个文件之后询问是否继续查看下一个文件的更改
 
-使用示例：
+注意事项:
+- 使用前必须先添加文件到aider,否则会提示使用 'aider.files.add' 命令
+- 可以使用 `aider.files.remove` 命令从aider中移除文件
+- 所有更改都会在IDE中以Diff视图形式展示,你可以决定是否应用这些更改
+- aider使用OpenAI的API,请确保已正确设置API密钥
+
+示例:
 /aider 重构这段代码以提高性能
 
-这个命令会让aider分析当前添加的文件，并提供重构建议以提高代码性能。
+额外信息:
+aider支持多种编程语言,可以执行代码重构、bug修复、性能优化等任务。它会分析当前添加的所有文件,并提供整体的改进建议。

merico/aider/command.py

@@ -201,7 +201,6 @@ def main():
             button.render()
 
             idx = button.clicked
-            print("click button:", idx)
             if idx == 0:
                 continue
             else:

merico/aider/files/add/README.md

@@ -1,20 +1,23 @@
 ### aider.files.add
 
-添加文件到aider处理列表中。
+这个命令用于将文件添加到aider的处理列表中。
 
-用法：
+用途:
+添加指定文件到aider,使其包含在后续的aider操作中。
+
+使用方法:
 /aider.files.add <file_path>
 
-参数：
-- <file_path>: 要添加的文件路径（必需）
+参数:
+- <file_path>: 要添加的文件路径(必需)
 
-描述：
-这个命令将指定的文件添加到aider的处理列表中。添加后，该文件将被包含在后续的aider操作中。
+注意事项:
+- 文件路径必须是有效的格式
+- 已存在于列表中的文件不会重复添加
+- 成功添加后会显示当前的aider文件列表
 
-注意：
-- 文件路径必须是有效的格式。
-- 如果文件已经在列表中，它不会被重复添加。
-- 添加成功后，会显示当前aider文件列表。
+示例:
+/aider.files.add src/main.py
 
-示例：
-/aider.files.add src/main.py
+额外信息:
+这个命令会将文件路径保存到.chat/.aider_files文件中。如果.chat目录不存在,会自动创建。

merico/aider/files/list/README.md

@@ -1,16 +1,19 @@
 ### aider.files.list
 
-列出当前在aider处理列表中的所有文件。
+这个命令用于列出当前在aider处理列表中的所有文件。
 
-用法：
+用途:
+显示所有已添加到aider中的文件,提供当前aider正在处理的文件概览。
+
+使用方法:
 /aider.files.list
 
-描述：
-这个命令会显示所有已添加到aider处理列表中的文件。它提供了一个当前aider正在处理的文件的概览。
+注意事项:
+- 如果没有文件被添加到aider,会显示相应的提示消息
+- 文件列表按字母顺序排序显示
 
-注意：
-- 如果没有文件被添加到aider，会显示相应的消息。
-- 文件按字母顺序排序显示。
+示例:
+/aider.files.list
 
-示例：
-/aider.files.list
+额外信息:
+这个命令会读取.chat/.aider_files文件的内容来获取文件列表。如果该文件不存在,会提示尚未添加任何文件。

merico/aider/files/remove/README.md

@@ -1,20 +1,23 @@
 ### aider.files.remove
 
-从aider处理列表中移除指定的文件。
+这个命令用于从aider处理列表中移除指定的文件。
 
-用法：
+用途:
+将指定文件从aider的处理列表中删除,使其不再包含在后续的aider操作中。
+
+使用方法:
 /aider.files.remove <file_path>
 
-参数：
-- <file_path>: 要移除的文件路径（必需）
+参数:
+- <file_path>: 要移除的文件路径(必需)
 
-描述：
-这个命令从aider的处理列表中移除指定的文件。移除后，该文件将不再被包含在后续的aider操作中。
+注意事项:
+- 文件路径必须是有效的格式
+- 如果指定的文件不在列表中,会显示相应的提示消息
+- 成功移除后会显示更新后的aider文件列表
 
-注意：
-- 文件路径必须是有效的格式。
-- 如果指定的文件不在列表中，会显示相应的消息。
-- 移除成功后，会显示更新后的aider文件列表。
+示例:
+/aider.files.remove src/main.py
 
-示例：
-/aider.files.remove src/main.py
+额外信息:
+这个命令会更新.chat/.aider_files文件,从中删除指定的文件路径。如果文件不存在于列表中,操作会安全退出。

merico/ask_issue/README.md

@@ -1,21 +1,24 @@
 ### ask_issue
 
-自动修复代码中的lint错误。
+自动修复代码中的 lint 错误。
 
-用法：
-/ask_issue
+#### 用途
+这个命令帮助开发者快速识别和修复代码中的 lint 错误。它利用 AI 分析选中的代码行，识别 lint 问题，并提供智能修复建议。
 
-描述：
-这个命令帮助开发者自动修复代码中的lint错误。它使用AI分析选中的代码行，识别lint问题，并提供修复建议。
+#### 使用方法
+1. 在 IDE 中选择包含 lint 错误的代码行。
+2. 运行命令：/ask_issue
+3. 命令会自动处理选中的代码和相关的 lint 诊断信息。
+4. AI 将生成问题解释和修复方案。
 
-步骤：
-1. 在IDE中选择包含lint错误的代码行。
-2. 运行 /ask_issue 命令。
-3. 命令会自动获取选中的代码、相关的lint诊断信息，并调用AI生成修复方案。
-4. AI会提供问题解释和修复后的代码片段。
+#### 注意事项
+- 运行命令前，确保已选择包含 lint 错误的具体代码行。
+- 命令优先处理 SonarLint 诊断的问题。
+- 只关注并修复选中行的 lint 错误，不会处理其他潜在问题。
+- AI 生成的修复方案包含问题解释和修改后的代码片段。
+- 修改后的代码以 Markdown 格式展示，包含足够的上下文信息以便定位。
 
-注意事项：
-- 确保在运行命令前已选择包含lint错误的代码行。
-- 命令会优先处理SonarLint诊断的问题。
-- AI生成的修复方案会包含问题解释和修改后的代码。
-- 修改后的代码会以Markdown格式展示，包含足够的上下文信息。
+#### 额外信息
+- 该命令使用 AI 模型进行分析和修复建议。
+- 修复建议会考虑代码的上下文，确保修改不会影响其他部分的正确性。
+- 对于复杂的 lint 错误，可能需要人工审核 AI 的修复建议。

merico/comments/README.md

@@ -1,11 +1,35 @@
 
-### 操作指南
+### comments
 
-生成行间注释，请按照如下步骤操作：
-1. 选中行间代码。
-2. 输入\/comments，回车发送；或右键点击**DevChat: Generate Comments**按钮。
-3. 开始生成行间注释，等待生成结束。
-4. 自动弹出Diff View，选择是否接受修改。
+这个命令用于自动为选中的代码块生成注释。
+
+#### 用途
+- 为选中的代码块快速添加解释性注释
+- 提高代码可读性和可维护性
+- 帮助开发者更好地理解代码逻辑
+
+#### 使用方法
+1. 在IDE中选中需要添加注释的代码块
+2. 执行以下命令之一：
+   - 输入 `/comments` 并回车
+
+#### 注意事项
+1. 确保在执行命令前已选中代码块
+2. 生成的注释会插入到相应的代码行之前
+3. 原有的注释会被保留
+4. 代码本身不会被修改，只会添加注释
+
+#### 操作流程
+1. 选中需要注释的代码块
+2. 执行comments命令
+3. 等待注释生成完成
+4. 自动弹出Diff View，您可以选择接受或拒绝修改
+
+
+额外信息
+注释的语言会根据当前IDE的语言设置自动调整
+对于中文环境，会生成中文注释
+该命令利用AI技术生成注释，可能需要一定的处理时间
 
 如图所示：
 

merico/docstring/README.md

@@ -1,11 +1,59 @@
 
-### 操作指南
+### docstring
 
-生成函数注释，请按照如下步骤操作：
-1. 选中函数代码。
-2. 输入\/docstring，回车发送；或点击函数头部**docstring**按钮。
-3. 开始生成函数注释，等待生成结束。
-4. 自动弹出Diff View，选择是否接受修改。
+这个命令用于自动为选中的函数或方法生成文档字符串（docstring）。
+
+#### 用途
+- 快速为函数或方法添加标准格式的文档字符串
+- 提高代码的可读性和可维护性
+- 自动生成包含参数、返回值等信息的详细文档
+
+#### 使用方法
+1. 在IDE中选中需要添加文档字符串的函数或方法
+2. 执行以下命令之一：
+   - 输入 `/docstring` 并回车
+   - 点击函数头部的 **docstring** 按钮
+
+#### 操作流程
+1. 选中需要添加文档字符串的函数或方法
+2. 执行docstring命令
+3. 等待文档字符串生成完成
+4. 自动弹出Diff View，您可以选择接受或拒绝修改
+
+#### 注意事项
+1. 确保在执行命令前已选中完整的函数或方法
+2. 生成的文档字符串会插入到函数定义之后
+3. 文档字符串的格式会根据编程语言自动调整（如Python使用三引号，Java使用JavaDoc格式）
+4. 原有的文档字符串可能会被替换，请在Diff View中仔细检查
+
+#### 示例
+选中以下Python函数：
+```python
+def add(a, b):
+    return a + b
+```
+执行docstring命令后，可能生成如下文档字符串：
+```python
+def add(a, b):
+    """
+    将两个数相加。
+
+    参数:
+    a (int): 第一个加数
+    b (int): 第二个加数
+
+    返回:
+    int: 两个数的和
+    """
+    return a + b
+```
+
+
+额外信息:
+
+- 文档字符串的语言会根据当前IDE的语言设置自动调整
+- 对于中文环境，会生成中文文档字符串
+- 该命令利用AI技术生成文档字符串，可能需要一定的处理时间
 
 如图所示：
 

merico/explain/README.md

@@ -1,10 +1,31 @@
 
-### 操作指南
+### explain
+
+这个命令用于自动为选中的代码块生成解释。
+
+#### 用途
+- 快速获取选中代码块的详细解释
+- 帮助开发者理解复杂或不熟悉的代码逻辑
+- 提高代码审查和学习效率
+
+#### 使用方法
+1. 在IDE中选中需要解释的代码块
+2. 执行以下命令之一：
+   - 输入 `/explain` 并回车
+   - 右键点击选中的代码，选择 **DevChat: Generate Explain**
+
+#### 操作流程
+1. 选中需要解释的代码块
+2. 执行explain命令
+3. 等待代码解释生成完成
+4. 解释将直接显示在输出窗口中
+
+#### 注意事项
+1. 确保在执行命令前已选中需要解释的代码块
+2. 解释会考虑选中代码的上下文（可见的代码），但只会解释选中的部分
+3. 解释的详细程度可能因代码复杂度而异
+4. 对于非常长或复杂的代码块，生成解释可能需要较长时间
 
-生成代码解释，请按照如下步骤操作：
-1. 选中行间代码。
-2. 输入\/explain，回车发送；或右键点击**DevChat: Generate Explain**按钮。
-3. 开始生成代码解释，等待生成结束。
 
 如图所示：
 

merico/fix/README.md

@@ -1,11 +1,38 @@
 
-### 操作指南
+### fix
 
-使用代码纠错，请按照如下步骤操作：
-1. 选中行间代码。
-2. 输入\/fix，回车发送；或右键点击**DevChat: Fix this**按钮。
-3. 开始生成代码建议，等待生成结束。
-4. 自动弹出Diff View，选择是否接受修改。
+这个命令用于自动检测和修复选中代码块中的潜在错误。
+
+#### 用途
+- 快速识别和修复代码中的潜在bug
+- 提高代码质量和可靠性
+- 节省手动调试时间
+
+#### 使用方法
+1. 在IDE中选中需要检查和修复的代码块
+2. 执行以下命令之一：
+   - 输入 `/fix` 并回车
+   - 右键点击选中的代码，选择 **DevChat: Fix this**
+
+#### 操作流程
+1. 选中需要修复的代码块
+2. 执行fix命令
+3. 等待代码分析和修复建议生成完成
+4. 自动弹出Diff View，您可以选择接受或拒绝修改
+
+#### 注意事项
+1. 确保在执行命令前已选中需要修复的代码块
+2. 该命令只会修改选中的代码部分，不会影响其他代码
+3. 修复建议可能不总是100%准确，请仔细审查所有建议的更改
+4. 复杂的逻辑错误可能需要人工干预
+
+#### 额外信息
+- 修复建议的语言会根据当前IDE的语言设置自动调整（支持中英文）
+- 该命令利用AI技术生成修复建议，可能需要一定的处理时间
+- 除了修复代码，还会提供关于发现的问题和修复方法的解释
+
+#### 提示
+使用fix命令可以快速发现和修复简单的代码错误，但对于复杂的逻辑问题，建议结合人工审查和测试来确保代码的正确性。
 
 如图所示：