# code_assistant

**Repository Path**: lrliang/code_assistant

## Basic Information

- **Project Name**: code_assistant
- **Description**: 代码文档自动维护助手
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-30
- **Last Updated**: 2026-04-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 代码文档自动维护助手

一个轻量级的本地代码文档自动维护工具，支持从 Git 仓库自动扫描代码变更并生成 Markdown 格式的文档。

## 功能特性

- **Git 集成**：支持本地和远程 Git 仓库，自动检测代码变更
- **多语言支持**：Python、JavaScript、TypeScript 代码扫描
- **智能识别**：自动识别函数、类、接口定义
- **文档生成**：生成格式化的 Markdown 文档
- **变更对比**：生成变更差异文件，方便追踪修改历史
- **轻量设计**：零复杂依赖，本地直接运行

## 项目结构

```
code-doc-assistant/
├── config.yaml           # 配置文件
├── main.py               # 主程序入口
├── core/                 # 核心模块
│   ├── __init__.py
│   ├── config_loader.py  # 配置加载器
│   ├── git_manager.py    # Git 仓库管理
│   ├── scanner.py        # 代码扫描器
│   └── doc_generator.py  # 文档生成器
├── utils/                # 工具模块
│   ├── __init__.py
│   └── logger.py         # 日志工具
├── output/               # 输出目录
│   ├── docs/             # 生成的文档
│   └── diff/             # 变更对比文件
└── requirements.txt      # 依赖列表
```

## 快速开始

### 1. 安装依赖

```bash
pip install -r requirements.txt
```

### 2. 初始化项目

```bash
python main.py --init
```

这会在当前目录创建 `config.yaml` 配置文件。

### 3. 配置仓库路径

编辑 `config.yaml`，设置您的代码仓库路径：

```yaml
git:
  local_repos:
    - path: "./your_repo"  # 改成您的仓库路径
      remote_url: ""
```

### 4. 运行扫描

扫描所有文件：
```bash
python main.py
```

仅扫描变更文件：
```bash
python main.py --changed-only
```

指定仓库路径：
```bash
python main.py -r /path/to/repo
```

## 使用方法

### 命令行参数

| 参数 | 说明 |
|------|------|
| `-c, --config` | 配置文件路径 (默认: config.yaml) |
| `-r, --repo` | 指定要扫描的仓库路径 |
| `--changed-only` | 仅扫描变更的文件 |
| `--since` | 获取变更的起始点 (默认: HEAD~1) |
| `--init` | 初始化项目配置 |

### 配置文件说明

详细配置选项请参考 `config.yaml` 文件：

- **git**: Git 仓库配置
- **scanner**: 扫描器配置（文件类型、排除目录等）
- **docs**: 文档生成配置（输出路径、命名格式等）
- **logging**: 日志配置

## 输出示例

生成的文档结构如下：

```markdown
# 模块文档: example_module

**文件路径**: `src/example_module.py`

**生成时间**: 2024-01-15 10:30:00

---

## 类定义

### `UserService`

---

## 函数列表

### `get_user`

**签名**: ```python
def get_user(user_id: int) -> User
```

**参数**:
- `user_id` (int)

**返回值**: `User`

---
```

## 注意事项

1. 确保系统已安装 Git 并在 PATH 中
2. 扫描的代码文件应保持 UTF-8 编码
3. 建议在运行前备份重要文档

## 扩展开发

项目采用模块化设计，便于扩展：

- `core/scanner.py`: 添加新的语言支持
- `core/doc_generator.py`: 自定义文档模板
- `core/git_manager.py`: 添加更多 Git 操作

## License

MIT License