CodeGeeX 提供了四种 README 生成方式，覆盖从单文件注释到全项目文档的完整需求：① VS Code 插件实时生成函数级 JSDoc 或 Python 注释；② 网页版上传项目压缩包批量生成标准化 README；③ CLI 工具批量注入 docstring 并生成顶层 README；④ GitHub Actions 自动检查 PR 中未文档化的公共接口。

如果你希望为开源项目快速生成一份结构完整、内容专业且符合社区规范的 README.md，但又不想花几小时手动组织章节、撰写安装说明或补充 API 列表——CodeGeeX 的这四种路径，基本能覆盖你从零到一的所有场景，帮你高效完成代码文档化。

VS Code 插件实时生成函数级 JSDoc/Python 注释

操作简单到几乎不需要费心：直接将光标停在函数定义上方即可。无需选中代码，也无需打开命令面板——只要确保插件已启用且模型加载完成。
按下 Ctrl+Shift+P（Windows/Linux）或 Cmd+Shift+P（macOS），输入“CodeGeeX: Generate Doc”并回车。
插件会自动分析当前函数签名与上下文逻辑，输出符合 JSDoc 或 Google Python Style 格式的注释块，包含用途、参数类型、返回值及示例用法。
【必须保存文件后再执行，否则插件无法读取完整 AST 结构】

网页版上传项目压缩包批量生成标准化 README.md

如果你的项目已有 src/、lib/ 以及 package.json 或 pyproject.toml，但缺少一份整体说明，这个方案特别适合。尤其是刚完成 MVP 想立刻发布到 GitHub 的开发者，几乎可以省掉手动编写文档的时间。
方法一：访问 CodeGeeX 官网在线代码理解服务页面 → 点击“上传项目”按钮 → 选择包含源码目录结构的 .zip 压缩包（注意不能是单个 .py 或 .ts 文件）→ 在模板选项中明确选择“Open Source Project README”。
方法二：首次使用需先完成邮箱验证；上传后等待 30–90 秒，系统会解析依赖树、识别入口文件、提取 CLI 命令和 HTTP 端点，再生成带锚点链接的章节化文档。
生成内容默认包含项目简介、安装步骤、快速开始示例、API 概览表及贡献指南——所有章节都基于实际代码推导，而非模板套话。

CLI 工具批量注入 docstring 并生成顶层 README

这是面向 CI/CD 流程和团队协作的生产级方案，要求本地环境已安装 Python 3.8+ 和 CodeGeeX CLI。
第一步：运行 codegeex-cli init 初始化配置，指定项目根路径与语言类型（如 --lang python）。
第二步：执行 codegeex-cli docstring --in-place --recursive src/，工具会遍历所有 .py 文件，在缺失 docstring 的函数前插入中文三段式注释。
第三步：运行 codegeex-cli readme --output README_zh.md，它会聚合所有已注入的 docstring、解析 setup.py 或 pyproject.toml 中的 metadata、抓取 .git/logs 中最近三次 commit message 作为更新日志。
【注意：--in-place 参数不可撤销，建议先用 --dry-run 预览修改位置】

GitHub Actions 集成自动检查 PR 中未文档化的公共接口

当团队要求“每个新增 public 函数必须带 docstring”，又不想依赖人工 Code Review 漏检时，这个方案能强制守住文档底线。
在项目根目录创建 .github/workflows/codegeex-doc.yml，粘贴官方提供的 Action YAML 模板。
该工作流会在每次 pull_request 触发时，调用 CodeGeeX API 扫描 diff 中新增的 def 或 public class 声明，比对是否已存在合规注释。
若检测到未文档化接口，Action 会直接失败并标注具体文件行号，阻止 PR 合并。
整个过程无需手动干预，只要推送代码，文档合规性就由机器人实时把关。