4.3 KiB

Raw Blame History

CodeGPT - 工具概览

工具类型：文档生成
工具分类：Documentation
最后更新：2025-11-26

📋 基本信息

工具简介

核心功能：作为 AI 代码助手，核心覆盖文档生成（代码注释、API 文档、README），支持批量生成与自定义模板，同时具备代码补全、调试等辅助功能，文档生成基于代码逻辑自动推导
适用场景：多语言项目文档快速补全、开源项目 README 初稿生成、团队代码注释标准化、无网络环境下本地文档生成
开发主体：CodeGPT 开源组织（GitHub Stars 7.8k+）

官方网站

官网：https://codegpt.co/
GitHub：https://github.com/carlrobertoh/CodeGPT
文档：https://docs.codegpt.co/zh-Hans/docs/tutorial-features/code_documentation

定价信息

免费版：开源核心功能全免费（文档生成、代码补全），支持接入免费开源模型（CodeLlama、Llama 2 等）
付费版：CodeGPT Cloud（$10 / 月），提供 GPT-4 Turbo/Claude 3 等商业模型接口，无需本地部署
开源：开源（MIT License）

大模型底座

底层模型：支持多种模型选择
- 开源模型：CodeLlama、Llama 2、Mistral、StarCoder等
- 商业模型：GPT-4 Turbo、Claude 3、Gemini Pro等
- 本地模型：支持通过Ollama等工具使用本地模型

🎯 核心功能

主要功能

代码注释：支持 Google Style Docstring、JSDoc、Javadoc 等主流风格，可自定义模板
README.md 自动生成与更新：包含快速开始、API 列表、安装依赖等核心模块
API 文档：支持导出 Markdown/HTML 格式，部分模型兼容 OpenAPI/Swagger 规范

适用场景

支持本地部署：离线可用，适配涉密项目
批量生成文档：支持整个项目 / 目录批量添加注释、生成统一 API 文档
自定义注释字段：可添加团队所需字段

不适用场景

自动更新需求：文档生成需手动触发，无自动监听代码变更实时更新功能
复杂继承关系：对复杂继承关系的类注释完整性不足，易遗漏父类方法说明
特定行业术语：对于金融、医疗等特定领域的专业术语理解有限

🛠️ 技术栈支持

支持的编程语言

Python：✅ 完全支持（版本要求：3.8+）
JavaScript/TypeScript：✅ 完全支持
Java：✅ 完全支持
Go：✅ 完全支持
C/C++：✅ 支持
C#：✅ 支持
PHP：✅ 支持
Ruby：✅ 支持
Rust：✅ 支持
Kotlin：✅ 支持
Swift：✅ 支持

支持的框架

Web框架：FastAPI、Flask、Django、Express.js、React、Vue、Angular、Spring Boot等
数据库：PostgreSQL、MySQL、MongoDB、Redis、SQLite等
其他：Docker、Kubernetes、TensorFlow、PyTorch等主流框架

IDE集成

VS Code：✅ 完全支持（插件：CodeGPT）
IntelliJ IDEA：✅ 完全支持（插件：CodeGPT）
PyCharm：✅ 完全支持（插件：CodeGPT）
WebStorm：✅ 支持
Android Studio：✅ 支持
其他JetBrains IDEs：✅ 支持

🚀 部署方式

云端服务

SaaS：✅ 支持（提供云端服务）
API：✅ 支持（提供API接口）

本地部署

本地安装：✅ 支持（方式：IDE插件）
本地模型：✅ 支持（通过Ollama、LM Studio等工具运行本地模型）

混合部署

本地+云端：✅ 支持（描述混合模式）

📊 版本信息

当前版本

版本号：v3.8.0+
发布日期：2024-11
最后更新：2024-11

版本历史

v3.8.0（2024-11）：增强文档生成功能，支持更多编程语言
v3.5.0（2024-09）：添加自定义注释模板功能
v3.0.0（2024-06）：重构核心架构，提升性能

🔗 相关资源

学习资源

官方文档

社区

GitHub Discussions：https://github.com/carlrobertoh/CodeGPT/discussions

相关工具

GitHub Copilot：商业化的AI代码助手，功能更全面但需付费
Cursor：集成AI的代码编辑器，适合完整项目开发
Tabnine：专注于代码补全的AI工具