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合并。
这一步不需要你手动干预，只要推送代码，文档合规性就由机器人实时把关。