驯服GitHub Copilot：定制你的专属代码助手

2025-03-03 04:24:23

驯服 GitHub Copilot：定制你的代码助手

在使用 GitHub Copilot 的时候你是否遇到过这种情况：它生成的代码风格和你预期的不太一样？或者测试用例不够全面？你可能会想，能不能像调教 ChatGPT 那样，给 Copilot 一些 “指示”，让它按照你的期望来生成代码？

这个问题很有代表性。很多开发者都希望能够更精细地控制 Copilot 的输出，让它更好地融入团队的开发流程，避免代码风格的差异。好消息是，虽然 Copilot 没有提供一个像 ChatGPT 那样的直接设置界面，但我们可以通过一些方法来实现类似的效果。

为什么需要定制 Copilot？

Copilot 的强大之处在于它能够根据上下文生成代码，但这种 “智能” 有时也会带来问题。不同的开发者有不同的编码习惯，团队可能有统一的规范。如果 Copilot 生成的代码与这些习惯或规范不符，就会导致：

代码风格不一致，影响可读性。
测试覆盖不全面，增加潜在风险。
需要额外的人工 review 和修改，降低开发效率。

所以，我们需要一些方法来 “驯服” Copilot, 让它更好地为我们服务。

定制 Copilot 的方法

下面介绍几种常用的定制方法，它们各有特点，可以根据实际情况选择使用。

1. 通过注释和代码示例引导

Copilot 的核心是学习已有代码和注释，并据此生成新的内容。所以，我们可以通过提供清晰、详细的注释和代码示例，来引导它生成符合预期的代码。

原理： Copilot 会分析你写的注释，提取其中的需求和意图；它也会参考已有的代码，学习其中的风格和模式。注释越详细、代码示例越贴切，Copilot 生成的代码就越符合你的要求。

代码示例：

# 函数功能：计算两个数的最大公约数 (Greatest Common Divisor)
# 输入：两个整数 a 和 b
# 输出：a 和 b 的最大公约数
# 算法：使用辗转相除法 (Euclidean algorithm)
# 示例：
# gcd(12, 18) == 6
# gcd(25, 15) == 5

def gcd(a, b):
    # Copilot 很可能会根据上面的注释和示例，生成使用辗转相除法的代码。
    # ...
    pass

提供类似函数名, 以及函数的 docstrings 的格式和详细的介绍，都有利于 Copilot 产出特定格式的代码。

安全建议: 无。

2. 利用 `.editorconfig` 文件规范代码风格

.editorconfig 文件是一种用于在不同编辑器和 IDE 之间保持一致代码风格的配置文件。Copilot 可以读取这个文件，并根据其中的设置来生成代码。

原理： .editorconfig 文件定义了缩进、换行、字符集等代码风格相关的设置。 Copilot 会自动检测并应用这些设置，从而确保生成的代码符合项目的统一风格。

操作步骤：

在项目根目录下创建 .editorconfig 文件。

根据项目需求，添加相应的配置。例如：

root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.py]
indent_size = 4

[*.js]
indent_size = 2

安全建议: 无

3. 创建自定义的 “prompt” 文件

我们可以创建一个或多个专门用于存放 “prompt” 的文件。这些文件不参与实际的编译或运行，但包含了希望 Copilot 遵循的代码风格、模式、甚至特定任务的示例代码。

原理： Copilot 会扫描整个项目，包括这些 “prompt” 文件。它会学习这些文件中的内容，并将这些 “知识” 应用到代码生成中。

操作步骤：

创建一个目录，例如 copilot_prompts。
在目录中创建多个文件，每个文件对应一个主题或任务。例如 string_utils.py、array_helpers.js 等。
在文件中添加具有代表性的代码示例、注释、甚至是希望 Copilot 使用的函数签名。

代码示例： （copilot_prompts/string_utils.py）

def remove_prefix(text: str, prefix: str) -> str:
    """
    从字符串开头移除指定的前缀。

    Args:
        text: 原始字符串。
        prefix: 要移除的前缀。

    Returns:
        移除前缀后的字符串。如果原始字符串不以指定前缀开头，则返回原始字符串。
        示例：
        remove_prefix("HelloWorld", "Hello") == "World"
        remove_prefix("Foobar", "Bar") == "Foobar"
    """
    if text.startswith(prefix):
        return text[len(prefix):]
    return text

当你需要执行相似功能, 可以打开 copilot_prompts/string_utils.py, copilot 将参考 copilot_prompts/string_utils.py 里的内容，根据你的当前输入，产出和 copilot_prompts/string_utils.py 更加相近的内容。

安全建议： 不要在 “prompt” 文件中包含敏感信息，比如 API 密钥、密码等。

4. (进阶)结合项目内的 `.github` 文件夹定制

如果你的代码托管在 GitHub 上，并且启用了 Codespaces，可以充分利用 .github 文件夹的功能来定制。

原理： .github 文件夹中可以包含 devcontainer.json 和 codespaces-requirements.txt 等配置文件, 定义 Codespaces 开发环境. Copilot 集成了这些配置信息, 可以更加紧密的结合 Codespaces 进行定制。

使用场景 针对项目特定的 settings, extension 和工具集等。通过 devcontainer 进行控制. 比如在 python 中强制要求项目的代码规范, 和 CI/CD 流程中的格式规范相匹配。

.devcontainer/devcontainer.json 示例:

{
	"name": "My Python Project",

	// Configure tool-specific properties.
	"customizations": {
		// Configure properties specific to VS Code.
		"vscode": {
			// Add the IDs of extensions you want installed when the container is created.
            // 强制安装 pylint, 自动安装 pre-commit 等插件
            // 配置 pylint, 开启项目要求的各种 rules.
			"extensions": [
                "ms-python.pylint",
                "ms-python.python"
			],
            "settings":{
                 "python.linting.pylintEnabled": true,
                 "python.linting.enabled": true,
                 "[python]": {
                    "editor.codeActionsOnSave": {
                      "source.fixAll": true
                    }
                }
            }

		}
	}
}