当前位置：首页 > 谈天说地

Unity脚本自动添加头部注释的全过程

34资源网2022-01-06715

unity脚本自动添加头部注释

就是创建.cs文件时自动添加作者名，创建时间，文件名等

看示例，我们在unity的project面板下先创建一个scripts文件夹，然后在scripts文件夹下创建一个脚本，命名为：test.cs

然后就是这样：

因为这个是我已经成功的设置过了才会有这样的头部注释

1. 修改unity模板

首先找到你的unity的安装路径，找到这样的文件夹，文件名字是和版本相关的

然后打开文件夹，一路找到editor\data\resources\scripttemplates文件夹

然后嘛，打开一个叫做81-c# script-newbehaviourscript.cs.txt的文件，打开

是这样：

using system.collections;
using system.collections.generic;
using unityengine;

    #rootnamespacebegin#
public class #scriptname# : monobehaviour
{
    // start is called before the first frame update
    void start()
    {
        #notrim#
    }

    // update is called once per frame
    void update()
    {
        #notrim#
    }
}
#rootnamespaceend#

这个就是我们的脚本创建的模板文件，我们创建的每个脚本文件长什么样，都是跟这个东西有关系的

我们只需要在上面加上注释，当然还是不够的

加上

/**
 * ==========================================
 * filename：#filename#
 * author：#name#
 * creattime：#createtime#
 * nowpath：#path#
 * ==========================================
 */

然后保存退出

再创建一个脚本试试看，就会多出这些东西，当然这些都是写死的，固定的

我们可以看看仅此的效果：

是吧，只是写死的

2. 通过代码修改为动态的

注意到我创建的editor文件夹了吗？

虽然那个是我自己创建的，但是unity中某些文件夹就是具有着某些特殊的作用

比如这个editor它的作用就是：

以editor命名的文件夹允许其中的脚本访问unity editor的api。如果脚本中使用了在unityeditor命名空间中的类或方法，它必须被放在名为editor的文件夹中。editor文件夹中的脚本不会在build时被包含。
在项目中可以有多个editor文件夹。

然后我们先创建一个editor文件夹，然后再在这个文件夹下面创建一个脚本，名字随意都行，然后写代码

using unityengine;    
using unityeditor;	// 被继承的类所在的命名空间
using system.io;	// io文件操作命名空间
using system;		// c#基础功能命名空间
using system.text.regularexpressions;	// 正则表达式的命名空间

public class titleset : unityeditor.assetmodificationprocessor
{
   private static void onwillcreateasset(string path)
   {
       path = path.replace(".meta", "");   // 这里跌path是你的项目主路径asset/scripts/文件名
       if (path.endswith(".cs"))    // 判断是否是c#文件
       {
           string filename = regex.match(path, @"[^/]*$").value;    // 通过正则拿到仅含文件名的字符串
           string str = file.readalltext(path);    // 获取创建的文件名的全部内容
           str = str.replace("#name#", "布小禅").replace("#createtime#", datetime.now.tostring("yyyy-mm-dd hh:mm:ss")).replace("#filename#", filename).replace("#path#", path);    // 将头部注释替换
           file.writealltext(path, str);   // 将替换后的内容写入文件，将原内容覆盖
           assetdatabase.refresh();   
       }
   }
}

代码里面的注释已经让代码很清晰了，所以我就不多说了

你想自己添加别的信息，也可以添加