# AutoComment

**Repository Path**: kujj/auto-comment

## Basic Information

- **Project Name**: AutoComment
- **Description**: 自动给c、h文件添加文件批注程序
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-20
- **Last Updated**: 2025-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AutoComment

AutoComment 是一个用于自动给代码文件添加头部和尾部注释的工具，支持选择目录并扫描其中的文件，预览修改内容，并进行批量处理。

## 功能特性

- 自动加载配置文件（head.txt 和 end.txt）。
- 支持选择目录并扫描目录下的所有文件。
- 提供文件修改预览功能。
- 支持批量处理文件并添加注释。

## 使用方法

1. 运行程序后，会弹出一个图形界面。
2. 点击 "选择目录" 按钮，选择需要处理的目录。
3. 程序会自动扫描目录下的文件，并显示在预览窗口中。
4. 点击 "处理文件" 按钮，程序会根据配置文件（head.txt 和 end.txt）自动给文件添加头部和尾部注释。

## 文件说明

- `AutoComment.py`：主程序文件，包含图形界面和文件处理逻辑。
- `head.txt`：头部注释模板文件。
- `end.txt`：尾部注释模板文件。

## 注意事项

- 请确保 `head.txt` 和 `end.txt` 文件与 `AutoComment.py` 文件在同一目录下。
- 本工具适用于 Python 3.x 环境运行。

## 许可证

本项目采用 MIT 许可证。详情请查看项目根目录下的 LICENSE 文件。