# Yan Documentor

**Repository Path**: Yan_dy/yan-documentor

## Basic Information

- **Project Name**: Yan Documentor
- **Description**: 📄 Yan Documentor - 软著代码文档生成工具 🔖 

✨ 一键扫描源码，自动生成符合软著申请标准的 DOCX/PDF 文档

💡 支持 Java/Vue/Python/Go 等多语言 | 🚫 智能过滤 | 📏 专业排💡 支持 Java/Vue/Python/Go 等多语言 | 🚫 智能过滤 | 📏 专业排版

🎯 让代码著作权申请更简单
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-26
- **Last Updated**: 2026-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">

<img src="logo.png" alt="Yan Documentor Logo" width="120" height="120">

# Yan Documentor

**软件著作权文档生成平台**

[![Java Version](https://img.shields.io/badge/Java-17%2B-orange?style=flat-square&logo=openjdk)](https://adoptium.net/)
[![License](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](LICENSE)
[![Version](https://img.shields.io/badge/Version-1.0.0-green?style=flat-square)](http://doc.yancloud.icu/)

一款专为软件著作权申请设计的源代码文档生成工具，支持批量生成 DOCX/PDF 格式文档

[🌐 官网](http://doc.yancloud.icu/) · [📥 下载](#-下载安装) · [📖 使用文档](#-使用说明) · [🐛 反馈问题](https://github.com/your-repo/issues)

</div>

---

## ✨ 功能特性

- 📄 **多格式导出** - 支持 Word (DOCX) 和 PDF 两种格式
- 🚀 **批量处理** - 一键处理多个源代码文件，大幅提升效率
- 🎨 **可定制配置** - 自定义每页行数、字体大小、页眉页脚等
- 🔧 **智能注释移除** - 自动识别并移除各类编程语言的注释
- 📁 **多语言支持** - 支持 Java、Python、JavaScript、C/C++ 等主流语言
- 🖥️ **友好界面** - 基于 JavaFX 的现代化桌面应用

## 📥 下载安装

### 方式一：直接下载（推荐）

下载打包好的可执行程序，**无需安装 Java 环境即可运行**：

1. 前往 [官网下载页面](http://doc.yancloud.icu/) 或 Releases 页面
2. 下载 `Yan Documentor.zip`
3. 解压后双击 `Yan Documentor.exe` 运行

### 方式二：从源码构建

**环境要求：**
- JDK 17 或更高版本
- Maven 3.6+
- 仓库自带 `lib/javafx-sdk-17.0.2`

**构建步骤：**

```bash
# 克隆仓库
git clone https://gitee.com/Yan_dy/yan-documentor.git
cd yan-documentor

# 编译打包
mvn clean package -Pjavafx -DskipTests

# 生成可执行 JAR
# 如需生成独立可执行程序，继续运行：
build-exe.bat
```

打包完成后，可执行程序位于 `dist/new-output/Yan Documentor/`。

## 📖 使用说明

### 基本操作

1. **选择源码目录** - 点击「选择目录」按钮选择包含源代码的文件夹
2. **配置参数** - 设置每页行数、字体大小、文档标题等选项
3. **生成文档** - 点击「开始生成」按钮，等待处理完成
4. **查看结果** - 生成的文档保存在输出目录中

### 支持的文件类型

| 语言 | 扩展名 |
|------|--------|
| Java | `.java` |
| Python | `.py` |
| JavaScript | `.js`, `.jsx`, `.ts`, `.tsx` |
| C/C++ | `.c`, `.cpp`, `.h`, `.hpp` |
| C# | `.cs` |
| Go | `.go` |
| Rust | `.rs` |
| HTML/CSS | `.html`, `.css` |
| SQL | `.sql` |
| XML/JSON | `.xml`, `.json` |

### 配置选项

| 选项 | 说明 | 默认值 |
|------|------|--------|
| 每页行数 | 控制文档每页显示的代码行数 | 50 |
| 字体大小 | 代码字体大小 (pt) | 10 |
| 字体名称 | 代码字体 | Consolas |
| 是否移除注释 | 是否删除代码中的注释 | 是 |

## 🛠️ 技术栈

- **前端界面**: JavaFX 17
- **构建工具**: Maven
- **文档生成**: Apache POI (DOCX), Apache PDFBox (PDF)
- **日志框架**: SLF4J + Logback

## 📁 项目结构

```
yan-documentor/
├── src/
│   ├── main/
│   │   ├── java/com/ruanzhu/
│   │   │   ├── App.java              # 应用入口
│   │   │   ├── controller/           # 控制器
│   │   │   ├── model/                # 数据模型
│   │   │   ├── service/              # 业务逻辑
│   │   │   └── util/                 # 工具类
│   │   └── resources/
│   │       ├── fxml/                 # UI 布局
│   │       ├── css/                  # 样式文件
│   │       └── images/               # 图片资源
│   └── test/                         # 测试代码
├── lib/                              # JavaFX SDK
├── dist/                             # 打包输出
├── pom.xml                           # Maven 配置
├── build.bat                         # 打包脚本 (需 Java)
└── build-exe.bat                     # 打包独立程序 (需 JDK)
```

## 🤝 参与贡献

欢迎提交 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

## 📄 开源协议

本项目基于 [MIT License](LICENSE) 开源。

## 📮 联系方式

- 🌐 官网: [http://doc.yancloud.icu/](http://doc.yancloud.icu/)
- 📧 Email: yan1026@126.com

---

<div align="center">

**如果这个项目对你有帮助，请给一个 ⭐ Star 支持一下！**

Made with ❤️ by Yan Studio

</div>