Unity创建脚本自动添加头部格式

在开发脚本中添加头部格式,能够方便自己和他人阅读脚本基本信息,也能够在协同开发中快速找到对应模块开发人员。本文介绍一下Unity中创建脚本自动添加头部信息格式的方式。

效果图:

Unity创建脚本自动添加头部格式

创建教程:

  1. 找到Unity安装目录,如Unity2018.1\Editor\Data\Resources\ScriptTemplates文件夹下的81-C# Script-NewBehaviourScript.cs.txt,这是Unity的脚本模板,可以修改成你想要的格式。
  2. 这时你创建的脚本都可以换成该模板,如果需要在模板上面加时间等变量信息,手动输入修改太麻烦,可以自动用代码替换变量即可。修改txt如下。

81-C# Script-NewBehaviourScript.cs.txt

/****************************************************
	文件:#SCRIPTNAME#.cs
	作者:York_New
	博客:https://blog.****.net/York_New
	日期:#CreateTime#
	功能:Nothing
*****************************************************/

using UnityEngine;

public class #SCRIPTNAME# : MonoBehaviour 
{

}

然后在Unity工程中创建Plugins/Editor文件夹,将ScriptsInfoRecoder.cs脚本放入该文件夹即可。

ScriptsInfoRecoder.cs

using System;
using System.IO;

public class ScriptsInfoRecoder : UnityEditor.AssetModificationProcessor {
    private static void OnWillCreateAsset(string path) {
        path = path.Replace(".meta", "");
        if (path.EndsWith(".cs")) {
            string str = File.ReadAllText(path);
            str = str.Replace("#CreateAuthor#", Environment.UserName).Replace(
                              "#CreateTime#", string.Concat(DateTime.Now.Year, "/", DateTime.Now.Month, "/",
                                DateTime.Now.Day, " ", DateTime.Now.Hour, ":", DateTime.Now.Minute, ":", DateTime.Now.Second));
            File.WriteAllText(path, str);
        }
    }
}

这时候在Unity工程中创建脚本都可以自动创建头部格式

Unity创建脚本自动添加头部格式