# code2doc

**Repository Path**: chengyangz/code2doc

## Basic Information

- **Project Name**: code2doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-19
- **Last Updated**: 2025-03-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 代码文档自动生成系统

基于LangChain + Ollama + RAG的自动化代码文档生成工具。

## 功能特点

- **自动分析代码结构和依赖关系**
- **使用本地Ollama模型生成专业文档**
- **支持多种编程语言**
- **提供REST API和WebSocket接口**
- **完全本地化部署，保护代码安全**

## 安装与使用

1. 安装依赖:
bash


2. 确保Ollama已安装并运行:
bash
ollama pull codellama

3. 运行文档生成:
bash
python main.py --project_path /path/to/your/project --model codellama
4. ## 命令行参数
--project_path TEXT 代码项目路径 [必需]
--output_dir TEXT 文档输出目录 [默认: ./output]
--vector_db_path TEXT 向量数据库路径 [默认: ./vectordb]
--model TEXT 使用的Ollama模型 [默认: codellama]
--file TEXT 单独处理的文件路径(可选)

## API服务

启动REST API服务:
bash
cd server
python fastapi_app.py

启动WebSocket服务:
bash
cd server


## 项目结构

- `configs/`: 配置文件
- `core/`: 核心处理逻辑
- `tools/`: 工具和模型管理
- `data/`: 数据加载和处理
- `server/`: API服务
- `tests/`: 测试套件
- `docs/`: 项目文档

## 支持的文件类型

- Python (.py)
- JavaScript (.js)
- TypeScript (.ts)
- Java (.java)
- JSON (.json)
- Markdown (.md)
- CSV (.csv)
- 文本文件 (.txt)

## 使用Ollama模型

系统支持以下Ollama模型:
- codellama (推荐用于代码文档生成)
- llama3
- mistral
- phi3

## 贡献

欢迎提交问题报告和功能请求。