codegeex支持四种文档生成方式：一、vs code插件实时生成函数级jsdoc/python注释；二、网页版上传项目压缩包批量生成标准化readme.md；三、cli工具批量注入docstring并生成顶层readme；四、github actions集成自动检查pr中未文档化的公共接口。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
如果您希望为开源项目生成专业、结构清晰的文档，但缺乏编写时间或技术写作经验，则可以借助CodeGeeX自动完成文档草稿生成。以下是使用CodeGeeX为开源项目创建项目文档的具体方法：
一、通过CodeGeeX插件在VS Code中实时生成文档
该方法适用于正在编辑源码的开发者，利用IDE内嵌的AI能力，基于当前文件上下文自动生成对应模块的说明文档。
1、在VS Code中安装CodeGeeX官方扩展插件。
2、打开项目中的一个核心源文件（如main.py或index.ts）。
3、选中全部代码或光标置于函数定义上方。
4、按下快捷键Ctrl+Shift+P（Windows/Linux）或Cmd+Shift+P（macOS），输入“CodeGeeX: Generate Doc”，回车执行。
5、插件将输出符合JSDoc或Google Python Style格式的注释块，其中包含函数用途、参数类型、返回值及示例用法。
二、使用CodeGeeX网页版批量处理README与API说明
该方法适合已有初步代码结构但缺少整体项目描述的场景，支持上传多个文件并生成统一风格的Markdown文档。
1、访问CodeGeeX官网提供的在线代码理解服务页面。
2、点击“上传项目”按钮，选择包含src/、lib/和package.json或pyproject.toml的根目录压缩包。
3、在模板选项中选择“Open Source Project README”。
4、点击“生成文档”，等待分析完成后下载生成的README.md文件。
5、生成内容默认包含项目简介、安装步骤、快速开始示例、API概览表及贡献指南章节。
CodeGeeX 2.21.0是智谱AI推出的AI编程助手版本，对Inline Chat功能进行了重大优化，包括UI设计升级、支持流式输出以提升响应速度，并新增“查看思路”按钮以便理解代码原理。同时，该版本在编辑器中新增CodeLens控件，支持一键“解释”代码或“添加注释”。目前该工具对个人开发者免费开放。
三、调用CodeGeeX CLI工具自动化注入文档注释
该方法面向需要持续集成文档更新的团队，可通过命令行对整个代码库执行批量文档增强操作。
1、在终端中运行npm install -g codegeex-cli（Node.js环境）或pip install codegeex-cli（Python环境）。
2、进入项目根目录，执行codegeex-doc --lang=python --output=docs/ --include="src/**/*.py"。
3、工具将扫描所有匹配文件，在缺失docstring的位置插入标准化文档模板。
4、执行codegeex-doc --readme --title="My Open Source Library"生成顶层README草案。
5、CLI输出的日志中会高亮显示已处理文件数、新增注释行数及潜在歧义函数提示。
四、在GitHub Actions中集成CodeGeeX文档检查流程
该方法用于保障每次PR提交时文档完整性，自动检测未注释的公共接口并阻止合并。
1、在项目根目录创建.github/workflows/doc-check.yml文件。
2、配置workflow触发条件为pull_request，并指定运行环境为ubuntu-latest。
3、添加步骤：检出代码、安装codegeex-cli、运行codegeex-doc --check --strict。
4、设置失败退出码为1时使工作流标记为失败。
5、检查规则默认覆盖public类、导出函数及__init__.py中暴露的符号，不校验测试文件与私有成员。
