GitHub Copilot文档编写神器：自动生成架构图与流程评测

确实可以做到。关键在于用带有三行英文注释的代码文件作为上下文，同时确保核心模块保持打开状态且无报错，再配合结构化的提示词逐步触发，就能让Copilot一次性生成Mermaid架构图与三级流程说明。

简单来说，你想让GitHub Copilot把你那些零散的代码直接“翻译”成清晰的项目架构图和文字说明，而不是靠手动写文档、画图、反复调整。关键在于绕过Copilot默认只补全单行代码的限制——通过特定的提示词结构、文件上下文控制与分步生成策略，把它的深层理解能力激发出来。

准备带注释的代码文件作为上下文

先打开项目里核心模块的源码文件，比如main.py或index.ts。在每个函数开头添加三行英文注释：第一行用“@description:”描述函数目标；第二行用“@input:”说明输入参数的类型和含义；第三行用“@output:”解释返回值。Copilot无法读取未打开的文件，所以关键逻辑文件必须牢牢放在编辑器的标签页中，且光标要停在注释下方。

修改完成后务必保存文件，并确认没有语法错误——Copilot解析有报错的代码时，会直接忽略整个文件上下文，这个细节很关键。

用结构化提示词触发架构图生成

在新建的Markdown文件中输入以下内容，并将光标停留在最后一行末尾：

```mermaid
graph TD
%% GitHub Copilot will generate architecture nodes and connections here based on open code files
```

按Ctrl+Enter（Windows/Linux）或Cmd+Enter（macOS）调出Copilot面板，输入提示词：“Generate Mermaid flowchart showing module dependencies and data flow between functions in currently open Python/TypeScript files. Use subgraphs for layers: 'API', 'Service', 'Repository', 'DB'. Omit implementation details like variable names.”

按Tab键接受建议。如果生成结果中出现了具体变量名或硬编码路径，说明上下文文件未打开或注释不规范——这里有个硬性要求：必须关闭所有无关代码文件，只保留1到3个核心模块。

分步生成流程描述文本

第一步：在空行输入“Step 1: Describe the high-level workflow of user authentication.”——等待Copilot输出3到4行概括性描述；

第二步：紧接着换行输入“Step 2: List each function involved, in order of execution, with its responsibility.”——Copilot会按调用链列出函数名和职责。如果出现未定义的函数，说明该函数所在的文件并未打开；

第三步：再换行输入“Step 3: For 'validate_token()', explain how it handles expired vs invalid tokens, and what error is thrown.”——这一步必须咬定具体的函数名与判断分支，Copilot才会从代码的if/else块中抽取出逻辑，否则它只会泛泛而谈。

来源：互联网