unity编辑器小工具---创建脚本的时候自动添加命名空间和注释

我们创建新的脚本的时候,为了方便 ,很多unity的程序员会去修改unity引擎的创建脚本的模版源码,这不失为一个非常方便的方法。但是弊端也是显而易见,每次升级unity版本的时候都要重新去改一次,太过麻烦,还有就是不利于自定义添加功能和修改。所以字考虑到这些因素之后 ,我决定自己写个拓展的编辑器小工具:

  1. 在Editor文件下创建个脚本AutoAddNamespace.cs,继承UnityEditor.AssetModificationProcessor ,并实现方法 public static void OnWillCreateAsset(string path)
  2. 其实 最重要的是获取到类名,这里使用正则匹配来获取到类名,这边正则匹配 为了防止出现误差,直接全部匹配整个unity创建的脚本类,来取得我们需要的类名。
  3. 我这边自己写了个脚本生成器类。

最后记得脚本一定要放在editor文件下具体代码如下:

//=======================================================
// 作者:Bowenk
// 描述:创建脚本自动添加命名空间
//=======================================================
using UnityEngine;
using System.Collections;
using System.IO;
using System.Text.RegularExpressions;


namespace Babybus.Uno
{
    public class AutoAddNamespace : UnityEditor.AssetModificationProcessor {
    
        private static readonly string AuthorCode = 
        "//=======================================================\r\n"
        +"// 作者:\r\n"
        +"// 描述:\r\n"
        +"//=======================================================\r\n";

        public static readonly string headCode = 
        "using UnityEngine;\r\n"
        +"using System.Collections;\r\n"
        +"\r\n";

        public static void OnWillCreateAsset(string path){
            //只修改C#脚本
            var scriptName = "";
            path = path.Replace(".meta", "");
            if(path.EndsWith(".cs")){
                string allText = "";
                allText += File.ReadAllText(path);
                scriptName = GetClassName(allText);
                if(scriptName != "")
                {
                    CreateClass(path, scriptName);
                }
            }
        }

        //创建新的类 
        public static void CreateClass(string path, string className)
        {
            var sb = new ScriptBuilder();   
                //添加命名空间    UnoCfg.App.CodeName()->自己定义的项目代码字段
            sb.WriteLine("namespace Bowenk." + FirstLetterUppercase(UnoCfg.App.CodeName()));
            sb.WriteCurlyBrackets();
            sb.Indent++;

            sb.WriteLine("public class #SCRIPTNAME# : MonoBehaviour");
            sb.WriteCurlyBrackets();
            sb.Indent++;

            var allText = AuthorCode + headCode + sb.ToString();
            //替换脚本名字
            allText = allText.Replace("#SCRIPTNAME#", className);
            File.WriteAllText(path, allText);
        }

         //首字母改成大写
        public static string FirstLetterUppercase(string str)
        {
            if(string.IsNullOrEmpty(str))
                return str;
            if(str.Length == 1)
                return str.ToUpper();
            
            var first = str[0];
            var rest = str.Substring(1);
            return first.ToString().ToUpper() + rest;
        }

        //获取unity自动创建的脚本类名
        public static string GetClassName(string allText){
            var patterm = "public class ([A-Za-z0-9_]+)\\s*:\\s*MonoBehaviour {\\s*\\/\\/ Use this for initialization\\s*void Start \\(\\) {\\s*}\\s*\\/\\/ Update is called once per frame\\s*void Update \\(\\) {\\s*}\\s*}";
            var match = Regex.Match(allText, patterm);
            if(match.Success){
                return match.Groups[1].Value;
            }
            return "";
        }

    }
}

还有就是使用到的一个脚本生成器

//=======================================================
// 作者:Snake
// 描述:自定义创建脚本生成器
//=======================================================
public class ScriptBuilder
    {
            private const string NEW_LINE = "\r\n";
            public ScriptBuilder()
            {
                builder = new StringBuilder();
            }

            private StringBuilder builder;
            public int Indent { get; set; }

            private int currentCharIndex;

            public void Write(string val, bool noAutoIndent = false)
            {
                if (!noAutoIndent)
                    val = GetIndents() + val;
                if (currentCharIndex == builder.Length)
                    builder.Append(val);
                else
                    builder.Insert(currentCharIndex, val);
                currentCharIndex += val.Length;
            }

            public void WriteLine(string val, bool noAutoIndent = false)
            {
                Write(val + NEW_LINE);
            }

            public void WriteCurlyBrackets()
            {
                var openBracket = GetIndents() + "{" + NEW_LINE;
                var closeBracket = GetIndents() + "}" + NEW_LINE;
                Write(openBracket + closeBracket, true);
                currentCharIndex -= closeBracket.Length;
            }

            public string GetIndents()
            {
                var str = "";
                for (var i = 0; i < Indent; i++)
                    str += "    ";
                return str;
            }

            public override string ToString()
            {
                return builder.ToString();
            }
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351

推荐阅读更多精彩内容