如何强制VSCode Copilot /doc命令默认使用Numpy格式文档字符串？

问题分析 #

你尝试通过配置github.copilot.chat.experimental.codeGeneration.instructions来让Copilot默认生成带完整参数和返回值描述的Numpy格式文档字符串，但该配置仅作用于代码生成场景，对/doc指令触发的文档字符串生成操作不生效，因此无法达到预期效果。

可行替代方案 #

1. 自定义Copilot快捷触发指令 #

在VSCode用户片段中创建快捷模板，输入触发词即可自动调用/doc numpy format：

• 打开VSCode设置，搜索Configure User Snippets
• 选择python.json（针对Python文件配置）
• 添加如下片段：

{
  "Numpy Docstring Trigger": {
    "prefix": "npdoc",
    "body": ["/doc numpy format"],
    "description": "快速触发Copilot生成Numpy格式文档字符串"
  }
}

之后在函数上方输入npdoc并按Tab，就能自动触发Copilot生成指定格式的文档字符串。

2. 结合文档字符串插件配合使用 #

借助专门的Python文档字符串插件生成Numpy格式模板，再用Copilot补充细节：

• 安装autoDocstring插件
• 打开插件设置，将Docstring Format设置为numpy
• 在函数定义后输入三个双引号"""，插件会自动生成Numpy格式的文档模板，再通过Copilot填充参数、返回值的具体描述内容。

3. 修改Copilot Chat系统提示词（实验性） #

通过调整Copilot Chat的系统提示词，强制其默认使用Numpy格式生成文档：

• 打开VSCode设置，搜索github.copilot.chat.systemPrompt
• 在原有提示词末尾添加：当生成Python代码的文档字符串时，默认采用Numpy格式，需包含完整的参数类型、参数描述及返回值信息。
  注意：此方法可能影响Copilot其他场景的响应逻辑，需根据实际使用情况调整。

内容的提问来源于stack exchange，提问作者Ian Hellen