# CodeGenerator

**Repository Path**: xuxiaowengit/CodeGenerator

## Basic Information

- **Project Name**: CodeGenerator
- **Description**: 软著代码生成器，基于.net framework框架
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 50
- **Created**: 2024-07-21
- **Last Updated**: 2026-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CodeGenerator - 软著代码生成器

> 自动生成符合软件著作权登记要求的源代码文档工具

## 项目简介

CodeGenerator 是一个基于 .NET Framework 的桌面应用程序，可以自动将源代码文件格式化为符合中国软件著作权登记要求的文档（Word和Text格式）。

### 适用场景

- 📝 软件著作权登记源代码文档准备
- 📄 自动格式化代码为固定页数和行数
- 🎯 支持多种编程语言（Java、C#、C++、Python等）
- 📋 自动生成前后各30页，每页55行的标准格式

## 功能特点

✨ **核心功能**
- 支持多文件类型同时处理（.cs、.java、.cpp、.py、.kt等）
- 自动截取代码前30页和后30页（符合软著要求）
- 生成Word文档(.docx)和纯文本(.txt)两种格式
- 可视化界面，操作简单直观
- 支持文件夹批量处理

🎯 **智能处理**
- 自动过滤编译文件（建议不包含build文件夹）
- 代码行数自动统计
- 自定义保存路径
- 文件预览功能

## 技术栈

- **开发框架**: .NET Framework 4.x+
- **界面框架**: Windows Forms / WPF
- **文档生成**: Microsoft Office Interop / NPOI
- **开发语言**: C#

## 目录结构

```
CodeGenerator/
├── CodeGenerator.sln         # 解决方案文件
├── CodeGenerator/            # 主项目代码
│   ├── Form1.cs              # 主窗体
│   ├── CodeGenerator.csproj  # 项目配置
│   └── ...
├── Example/                  # 示例和发布文件
│   └── CodeGeneratorSetup.exe # 安装包
├── LICENSE                   # 许可证
└── README.md                 # 项目文档
```

## 安装使用

### 系统要求

- Windows 7 / 10 / 11
- .NET Framework 4.0+
- Microsoft Office (可选，用于Word文档生成)

### 安装步骤

#### 方式1: 直接下载安装包

1. 下载发布包: [CodeGeneratorSetup.exe](Example/CodeGeneratorSetup.exe)
2. 双击安装，按照向导完成安装
3. 从开始菜单或桌面快捷方式启动

#### 方式2: 从源码编译

```bash
# 克隆项目
git clone https://gitee.com/xuxiaowengit/CodeGenerator.git
cd CodeGenerator

# 使用Visual Studio打开 CodeGenerator.sln
# 编译运行 (F5)
```

## 使用教程

### 步骤1: 选择源代码文件

点击【选择文件（夹）】按钮，选择需要格式化的代码源文件或文件夹。

⚠️ **注意**: 尽量不要将build文件夹带上，因为编译项目会产生大量编译文件，可能导致加载缓慢。

### 步骤2: 配置文件类型

添加需要格式化的代码后缀，如：
- Java项目: `java`
- C#项目: `cs`
- C++项目: `cpp`, `h`
- Python项目: `py`
- Kotlin项目: `kt`

支持多文件类型同时格式化。

### 步骤3: 预览文件（可选）

双击文件列表中的文件，会使用系统默认软件打开该文件，方便预览确认。

### 步骤4: 生成文档

点击【生成文档】按钮，程序会自动：

1. 统计代码行数
2. 如果超过3000行（理论要求3000行，实际只需要前后各30页），自动截取：
   - 前30页（每页55行，共1650行）
   - 后30页（每页55行，共1650行）
3. 生成两份文档：
   - Word文档（.docx）
   - 纯文本文档（.txt）
4. 默认保存到桌面，可在设置中修改保存路径

### 输出文档格式

```
文档结构:
- 第1-30页: 源代码前30页，每页55行
- 第31-60页: 源代码后30页，每页55行
- 总计: 60页，3300行（符合软著要求）
```

## 常见问题

### Q1: 生成的文档在哪里？

A: 默认保存在桌面，文件名为 `软件著作权源代码_日期.docx/txt`。如果桌面没有，请在软件主界面右下角设置自定义保存路径。

### Q2: 代码行数不够3000行怎么办？

A: 如果代码行数不足，程序会使用示例代码填充或使用实际代码。建议源代码至少在2000行以上。

### Q3: 支持哪些编程语言？

A: 理论上支持所有文本格式的源代码，只需在添加文件类型时输入正确的文件后缀名即可。

### Q4: 生成的Word文档打不开？

A: 请确保系统已安装Microsoft Office或WPS Office。如果没有安装Office，可以使用生成的纯文本(.txt)文档。

## 更新日志

- **2026-06-15**: 完善项目文档，添加详细使用教程和常见问题
- **2024-07-21**: 项目初始化，发布第一个版本

## 许可证

本项目采用 Apache License 2.0 开源许可证。详见 [LICENSE](LICENSE) 文件。

## 贡献指南

欢迎提交Issue和Pull Request！

1. Fork 本项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request

## 联系方式

- 作者: xuxiaowengit
- Gitee: https://gitee.com/xuxiaowengit
- 问题反馈: https://gitee.com/xuxiaowengit/CodeGenerator/issues

---

**💡 提示**: 如果觉得这个工具对你有帮助，欢迎给项目点个Star ⭐


---

## 📝 文档完善记录

**完善时间**: 2026-06-15

### 项目类型

C#桌面应用

### 建议补充内容

- [ ] 详细的功能描述
- [ ] 完整的技术栈说明
- [ ] 清晰的使用示例
- [ ] 准确的安装步骤
- [ ] 必要的注意事项

### 快速导航

- 项目主页: https://gitee.com/xuxiaowengit/CodeGenerator
- 问题反馈: https://gitee.com/xuxiaowengit/CodeGenerator/issues

---

*本文档完善由CodeBuddy AI辅助完成*


---

## 📝 文档完善记录

**完善时间**: 2026-06-15

### 项目类型

C#桌面应用

### 建议补充内容

- [ ] 详细的功能描述
- [ ] 完整的技术栈说明
- [ ] 清晰的使用示例
- [ ] 准确的安装步骤
- [ ] 必要的注意事项

### 快速导航

- 项目主页: https://gitee.com/xuxiaowengit/CodeGenerator
- 问题反馈: https://gitee.com/xuxiaowengit/CodeGenerator/issues

---

*本文档完善由CodeBuddy AI辅助完成*


---

## 📝 文档完善记录

**完善时间**: 2026-06-15

### 项目类型

C#桌面应用

### 建议补充内容

- [ ] 详细的功能描述
- [ ] 完整的技术栈说明
- [ ] 清晰的使用示例
- [ ] 准确的安装步骤
- [ ] 必要的注意事项

### 快速导航

- 项目主页: https://gitee.com/xuxiaowengit/CodeGenerator
- 问题反馈: https://gitee.com/xuxiaowengit/CodeGenerator/issues

---

*本文档完善由CodeBuddy AI辅助完成*