# SourceCodeDoc
**Repository Path**: LeastBit/SourceCodeDoc
## Basic Information
- **Project Name**: SourceCodeDoc
- **Description**: 专为软件著作权申请设计的源代码自动转 Word 文档工具，支持智能分页、格式优化、批量处理，提供 GUI 与 CLI 两种操作方式，输出标准 docx 格式，适配多种编程语言。
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-10-27
- **Last Updated**: 2025-12-12
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 📄 源程序文档生成软件
**专为软件著作权申请设计的源代码文档自动生成工具**
[功能特点](#-功能特点) • [快速开始](#-快速开始) • [使用指南](#-使用指南) • [开发文档](#-开发文档) • [B站教程](https://www.bilibili.com/video/BV1DMGpzbEqr/?spm_id_from=333.1387.homepage.video_card.click&vd_source=33afd104a41faf98cb6a859069c293b4)
---
B站教程：https://www.bilibili.com/video/BV1DMGpzbEqr/?spm_id_from=333.1387.homepage.video_card.click&vd_source=33afd104a41faf98cb6a859069c293b4
## 🎯 项目简介
源程序文档生成软件是一个专业的源代码文档生成工具，专为软件著作权申请而设计。它能够将源代码文件自动转换为符合软件著作权申请要求的Word文档格式，大大简化了文档准备工作。
## ✨ 功能特点
### 📋 核心功能
- **智能分页**：自动按页数要求分页，支持全页面或前后30页模式
- **格式优化**：自动调整字体大小、行间距以适配页面要求
- **页眉定制**：支持自定义页眉内容，符合申请规范
- **批量处理**：支持单文件和文件夹批量处理
- **拖拽操作**：图形界面支持拖拽文件/文件夹操作
### 🖥️ 界面选择
- **图形界面（GUI）**：基于Electron的现代化界面，操作直观
- **命令行界面（CLI）**：支持脚本自动化，适合批量处理
### 📄 输出格式
- **Word文档**：生成标准的.docx格式文档
- **页码控制**：智能页码模式，优化大文件处理
- **内容结构**：保持源代码原有结构和格式
## 🚀 快速开始
### 📋 环境要求
- **Node.js** >= 14.0.0
- **npm** 或 **yarn**
- **操作系统**：Windows / macOS / Linux
### 📦 安装步骤
1. **克隆项目**
```bash
git clone https://github.com/LeastBit/SourceCodeDoc.git
cd SourceCodeDoc
```
2. **安装依赖**
```bash
npm install
```
3. **启动应用**
**图形界面版本：**
```bash
npm start
```
**命令行版本：**
```bash
node cli.js --help
```
### 🎯 快速体验
**使用图形界面：**
1. 运行 `npm start` 启动应用
2. 点击"选择文件"或"选择文件夹"
3. 配置文档设置（可选）
4. 点击"生成文档"
**使用命令行：**
```bash
# 基础用法
node cli.js input.txt
# 完整参数示例
node cli.js src/main.js --output result.docx --lines 45 --header "我的项目V1.0" --mode partial
```
## 📖 使用指南
### 🖥️ 图形界面使用
#### 文件选择
- **选择文件**：选择单个源代码文件
- **选择文件夹**：批量处理整个文件夹
- **拖拽操作**：直接拖拽文件或文件夹到界面
#### 文档设置
- **每页行数**：设置每页显示的代码行数（默认：50行）
- **页眉文本**：自定义页眉内容（默认：源程序V1.0）
- **页码模式**：
- `全部页面`：生成所有页面
- `前后30页`：当总页数超过60页时，只生成前30页和后30页
### 💻 命令行使用
#### 基本语法
```bash
node cli.js <输入文件路径> [选项]
```
#### 参数说明
| 参数 | 说明 | 默认值 | 示例 |
|------|------|--------|------|
| `<输入文件路径>` | 必需，源代码文件路径 | - | `src/main.js` |
| `--output <路径>` | 输出文件路径 | `output.docx` | `--output result.docx` |
| `--lines <数量>` | 每页行数 | `50` | `--lines 45` |
| `--header <文本>` | 页眉文本 | `源程序V1.0` | `--header "项目V2.0"` |
| `--mode <模式>` | 页码模式 | `all` | `--mode partial` |
## 🏗️ 项目结构
```
源程序文档生成软件/
├── 📁 src/ # 源代码目录
│ ├── 📁 main/ # 主进程模块
│ │ ├── 📄 codeParser.js # 代码解析器
│ │ ├── 📄 documentGenerator.js # 文档生成器
│ │ └── 📄 fileHandler.js # 文件处理器
│ └── 📁 renderer/ # 渲染进程模块
│ ├── 📄 index.html # 主界面
│ ├── 📄 main.js # 界面逻辑
│ └── 📄 style.css # 样式文件
├── 📄 main.js # Electron主进程入口
├── 📄 cli.js # 命令行入口
├── 📄 preload.js # 预加载脚本
├── 📄 package.json # 项目配置
└── 📄 README.md # 项目说明
```
## 🔧 开发文档
### 📚 核心模块说明
#### 🔍 codeParser.js
负责解析源代码文件，提取代码内容并进行预处理。
#### 📝 documentGenerator.js
核心文档生成模块，使用docx库生成Word文档，处理分页、格式化等功能。
#### 📂 fileHandler.js
文件操作模块，处理文件读取、路径解析等操作。
### 📋 使用问题
**Q: 支持哪些编程语言的源代码？**
A: 支持所有文本格式的源代码文件，包括但不限于：
- JavaScript (.js, .ts, .jsx, .tsx)
- Python (.py)
- Java (.java)
- C/C++ (.c, .cpp, .h)
- C# (.cs)
- PHP (.php)
- 其他文本格式文件
**Q: 如何处理大型项目？**
A: 建议：
- 使用"前后30页"模式处理大文件
- 分批处理多个文件
- 选择核心源代码文件进行处理
**Q: 生成的文档可以直接用于软件著作权申请吗？**
A: 本工具生成的文档格式符合一般要求，但建议：
- 根据具体申请机构要求进行微调
- 检查页眉页脚信息是否正确
- 确认页码和格式符合要求
## 📄 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
## 🙏 致谢
感谢以下开源项目：
- [Electron](https://electronjs.org/) - 跨平台桌面应用框架
- [docx](https://github.com/dolanmiu/docx) - Word文档生成库
- [fs-extra](https://github.com/jprichardson/node-fs-extra) - 文件系统操作增强
**如果这个项目对您有帮助，请给我们一个 ⭐ Star！**
Made with ❤️ by [leastbit](https://github.com/leastbit)