Unity杂文——脚本创建辅助ScriptBuilder

原文地址

简介

一个辅助快速生成需要的C#脚本的脚本。主要是快速生成引用,命名空间,类和方法一些。

脚本和解析

public class ScriptBuilder
{
    /// <summary>
    /// 脚本的字符串
    /// </summary>
    private StringBuilder m_Builder = new StringBuilder();
    /// <summary>
    /// 空白地字符串
    /// </summary>
    private StringBuilder m_Blank = new StringBuilder();

    /// <summary>
    /// 用于判断是否在方法内生成脚本
    /// </summary>
    public bool MarkInMethod { get; set; }

    /// <summary>
    /// 增加一行数据
    /// </summary>
    /// <param name="message"></param>
    public void AppendLine(string message)
    {
        m_Builder.Append(m_Blank);
        m_Builder.AppendLine(message);
    }

    /// <summary>
    /// 开始增加空白
    /// </summary>
    private void BeginBlank()
    {
        m_Blank.Append('\t');
    }

    /// <summary>
    /// 结束增加空白
    /// </summary>
    private void EndBlank()
    {
        m_Blank.Remove(m_Blank.Length - 1, 1);
    }

    /// <summary>
    ///开始增加命名空间
    /// </summary>
    /// <param name="name">命名空间的名字</param>
    public void BeginNamespace(string name)
    {
        BeginBrace($"namespace {name}");
    }

    /// <summary>
    /// 结束增加命名空间
    /// </summary>
    public void EndNamespace()
    {
        EndBrace();
    }

    /// <summary>
    /// 开始增加类
    /// </summary>
    /// <param name="modifier">类的修饰字符串</param>
    /// <param name="className">类的名字</param>
    /// <param name="superclass">继承类的名字</param>
    public void BeginClass(string modifier, string className, string superclass)
    {
        BeginBrace($"public {modifier} class {className} : {superclass}");
    }

    /// <summary>
    /// 开始增加类
    /// </summary>
    /// <param name="modifier">类的修饰字符串</param>
    /// <param name="className">类的名字</param>
    public void BeginClass(string modifier, string className)
    {
        BeginBrace($"public {modifier} class {className}");
    }

    /// <summary>
    /// 开始增加类
    /// </summary>
    /// <param name="className">类的名字</param>
    public void BeginClass(string className)
    {
        BeginBrace($"public class {className}");
    }

    /// <summary>
    /// 结束类
    /// </summary>
    public void EndClass()
    {
        EndBrace();
    }

    /// <summary>
    /// 开始增加方法
    /// </summary>
    /// <param name="method">方法名</param>
    /// <param name="permission">访问权限</param>
    /// <param name="returnType">返回类型</param>
    /// <param name="modifier">修饰符</param>
    public void BeginMethod(string method, string permission = "public", string returnType = "void",
        string modifier = "")
    {
        MarkInMethod = true;
        BeginBrace(string.IsNullOrEmpty(modifier)
            ? $"{permission} {returnType} {method}"
            : $"{permission} {modifier} {returnType} {method}");
    }

    /// <summary>
    /// 结束方法
    /// </summary>
    public void EndMethod()
    {
        EndBrace();
        MarkInMethod = false;
    }

    /// <summary>
    /// 开始属性
    /// </summary>
    /// <param name="property">属性名字</param>
    public void BeginProperty(string property)
    {
        BeginBrace(property);
    }

    /// <summary>
    /// 结束属性
    /// </summary>
    public void EndProperty()
    {
        EndBrace();
    }

    /// <summary>
    /// 大括号的开始
    /// </summary>
    /// <param name="code"></param>
    public void BeginBrace(string code)
    {
        AppendLine($"{code}");
        AppendLine("{");
        BeginBlank();
    }

    /// <summary>
    /// 结束大括号
    /// </summary>
    public void EndBrace()
    {
        EndBlank();
        AppendLine("}");
    }

    /// <summary>
    /// 开始字段
    /// </summary>
    /// <param name="code">Field的名字</param>
    public void BeginField(string code)
    {
        AppendLine($"{code}");
        AppendLine("{");
        BeginBlank();
    }

    /// <summary>
    /// 结束字段
    /// </summary>
    public void EndField()
    {
        EndBlank();
        AppendLine("};");
    }

    /// <summary>
    /// 开始Region
    /// </summary>
    /// <param name="name">Region的名字</param>
    public void BeginRegion(string name)
    {
        AppendLine($"#region {name}");
    }

    /// <summary>
    /// 结束Region
    /// </summary>
    public void EndRegion()
    {
        AppendLine("#endregion");
    }

    /// <summary>
    /// 转成字符串
    /// </summary>
    /// <returns></returns>
    public override string ToString()
    {
        return m_Builder.ToString();
    }
}

用法

上述方法就是辅助的脚本,下面是举例调用方法作为参考

// 获取类脚本的路径
var scriptPath = AssetDatabase.GUIDToAssetPath(kGUID);

var sb = new ScriptBuilder();
sb.BeginNamespace(typeof(StorageKeyConst).Namespace);
sb.BeginClass("static", "StorageKeyConst");
if (DataStorageEditorTools.Instance.DataStorageEditorDataRootList.Count > 0)
{
    sb.BeginRegion("RootKeys");
    sb.AppendLine(string.Empty);
    AddListScripts(sb, DataStorageEditorTools.Instance.DataStorageEditorDataRootList);
    sb.AppendLine(string.Empty);
    sb.EndRegion();
    sb.AppendLine(string.Empty);
}
if (DataStorageEditorTools.Instance.DataStorageEditorDataList.Count > 0)
{
    sb.BeginRegion("Keys");
    sb.AppendLine(string.Empty);
    AddListScripts(sb, DataStorageEditorTools.Instance.DataStorageEditorDataList);
    sb.AppendLine(string.Empty);
    sb.EndRegion();
}

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

推荐阅读更多精彩内容