📝 Unity Script Header 注釋生成器
一個輕量、可配置的 Unity 編輯器工具,在創建
.cs
腳本時自動插入統一格式的注釋頭信息。
支持作者、郵箱、公司、地點、版權、描述等字段,所有信息都可通過 Project Settings 界面配置并動態開關。
🎉GitHub開源地址:點擊跳轉
😃 適用多人協作開發,互不影響
📦 安裝方式(推薦 Git URL)
Git URL安裝
- 打開 Unity 項目
- 進入
Window > Package Manager
- 點擊左上角 “+” →
Add package from Git URL
- 輸入以下地址:
https://github.com/LiamLsc/unity-script-header.git
本地安裝
- GitHub > Releases > 下載到本地并解壓
- 進入
Window > Package Manager
- 點擊左上角 “+” →
Add package from disk
- 選擇本地文件夾下的
package.json
文件
🎮 使用方法
🧱 配置注釋字段
點擊菜單:Edit → Project Settings → Script Header
設置字段和開關:
- 腳本名(自動) - 日期(自動)
- 作者(Author) - 郵箱(Email)
- 公司(Company) - 地點(Location)
- 描述(Description) - 版權信息(Copyright)
- [?] 每項啟用開關
🧪 測試:創建腳本
通過右鍵菜單 Create > C# Script 創建腳本文件,即可自動插入如下格式:
// ======================================================
// 文件名: PlayerController.cs
// 創建時間: 2025-06-26 16:52:12
// 創建者: Liam
// 郵箱: liam@example.com
// 公司: YourCompany
// 地點: Shanghai, China
// 版權: ? 2025 YourCompany
// 描述: 控制玩家行為邏輯
// ======================================================
?? 功能特性
? 新建 C# 腳本時自動添加注釋頭
? 注釋字段完全可配置(作者、郵箱、公司、版權等)
? 每個字段支持獨立開關
? 支持通過 Project Settings 進行實時設置
? 防止重復插入注釋
? 使用命名空間封裝,避免命名沖突
? 完全符合 Unity UPM 包標準
📁 項目結構
Root/
├── package.json
├── README.md
├── CHANGELOG.md
├── LICENSE
├── Editor/
│ ├── AssetCreationProcessor.cs
│ ├── ScriptHeaderBuilder.cs
│ ├── ScriptHeaderConfig.cs
│ ├── ScriptHeaderSettingsProvider.cs
│ └── ScriptHeaderInitializer.cs
├── Resources/
│ └── ScriptHeaderConfig.asset
🧾 許可證 License
本項目使用 MIT License,可自由用于商業和個人項目。
? 2025 Liam. 保留署名權。
🙋 聯系方式與反饋
如有建議、問題或 bug,請提交 Issue 或創建 Pull Request。
或者在博客下方留言。