vs自动添加注释

最新推荐文章于 2024-07-02 17:24:37 发布

keneyr

最新推荐文章于 2024-07-02 17:24:37 发布

阅读量9k

点赞数 2

分类专栏：强编程工具文章标签： vs

本文链接：https://blog.csdn.net/keneyr/article/details/88662940

版权

强编程工具专栏收录该内容

45 篇文章 3 订阅

订阅专栏

:)也是服了我自己了，事到如今代码写的一团糟才想到要自动化注释显得的美观一点。凉凉。因为我的vs2013是独立安装的，vs2017是装Unity的时候在Unity下安装的。

首先说vs2013怎么自动生成头部注释：

找到vs2013的安装位置，在该路径下面，找到class文件，用笔记本或者notepad++什么的都行，把它打开

E:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class

在文件头部添加

/**
*┌──────────────────────────────────────────────────────────────┐
*│　描   述：                                                    
*│　作   者：Keneyr                                              
*│　版   本：1.0                                                 
*│　创建时间：$time$                             
*└──────────────────────────────────────────────────────────────┘
*┌──────────────────────────────────────────────────────────────┐
*│　命名空间: $rootnamespace$                                   
*│　类   名：$safeitemname$                                      
*└──────────────────────────────────────────────────────────────┘
*/

于是当你在工程中添加新的类文件的时候，就会自动出来这个注释了，如下：

/**
*┌──────────────────────────────────────────────────────────────┐
*│　描   述：                                                    
*│　作   者：Keneyr                                              
*│　版   本：1.0                                                 
*│　创建时间：2019/3/19 15:20:47                             
*└──────────────────────────────────────────────────────────────┘
*┌──────────────────────────────────────────────────────────────┐
*│　命名空间: Mesh2DV1                                   
*│　类   名：Class1                                      
*└──────────────────────────────────────────────────────────────┘
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Mesh2DV1
{
    class Class1
    {
    }
}

那么如何做到让函数也自动添加头部注释呢？似乎需要vs工具的拓展里下载VAssistX插件，这里我先不做实验了。可以参考该博客：

https://blog.csdn.net/ranjiewen/article/details/52595403

然后是vs2017中自动添加注释，我发现我的vs2017中找不到相关文件：

C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\ItemTemplates\CSharp\General\1033

那么应该怎么办呢。。。

找到Unity的安装位置，找到81开头的那个文件，没错这里就是我点击的位置，Unity中的脚本创建使用的是模板拷贝，拷贝的就是这个文件夹下的脚本：

D:\Program Files\Unity\Editor\Data\Resources\ScriptTemplates

然后打开它，在头部添加：

/**
*┌──────────────────────────────────────────────────────────────┐
*│　Description：                                                    
*│　Author：Keneyr                                              
*│　Version：#VERSION#                                                
*│　Date：#DATE#                              
*└──────────────────────────────────────────────────────────────┘
*┌──────────────────────────────────────────────────────────────┐
*│　NameSpace: #rootnamespace#                                   
*│　ClassName：#SCRIPTFULLNAME#                                      
*└──────────────────────────────────────────────────────────────┘
*/

这时候，自动创建的cs文件并不能自动识别出路径，效果是这样的：

还需要后面一步，创建文件，应该不一定非得在Editor文件夹下创建该文件，在哪里创建都行，读者可以一试：

using UnityEditor;
using UnityEngine;
using System.IO;

public class AddFileHeadComment : UnityEditor.AssetModificationProcessor
{
    /// <summary>
    /// 此函数在asset被创建完，文件已经生成到磁盘上，但是没有生成.meta文件和import之前被调用
    /// </summary>
    /// <param name="newFileMeta">newfilemeta 是由创建文件的path加上.meta组成的</param>
    public static void OnWillCreateAsset(string newFileMeta)
    {
        string newFilePath = newFileMeta.Replace(".meta", "");
        string fileExt = Path.GetExtension(newFilePath);
        if (fileExt != ".cs")
        {
            return;
        }
        //注意，Application.datapath会根据使用平台不同而不同
        string realPath = Application.dataPath.Replace("Assets", "") + newFilePath;
        string scriptContent = File.ReadAllText(realPath);

        //这里实现自定义的一些规则
        scriptContent = scriptContent.Replace("#SCRIPTFULLNAME#", Path.GetFileName(newFilePath));
        scriptContent = scriptContent.Replace("#AUTHOR#", "Keneyr");
        scriptContent = scriptContent.Replace("#VERSION#", "1.0");
        scriptContent = scriptContent.Replace("#UNITYVERSION#", Application.unityVersion);
        scriptContent = scriptContent.Replace("#DATE#", System.DateTime.Now.ToString("yyyy-MM-dd"));

        File.WriteAllText(realPath, scriptContent);
    }

}

随处创建一个cs文件，效果如下：

/**
*┌──────────────────────────────────────────────────────────────┐
*│　Description：                                                    
*│　Author：Keneyr                                              
*│　Version：1.0                                                
*│　Date：2019-03-19  
*│  UnityVersion: 2018.3.0f2                            
*└──────────────────────────────────────────────────────────────┘
*┌──────────────────────────────────────────────────────────────┐
*│　                                   
*│　ClassName：NewBehaviourScript.cs                                      
*└──────────────────────────────────────────────────────────────┘
*/
using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class NewBehaviourScript : MonoBehaviour
{
    // Start is called before the first frame update
    void Start()
    {
        
    }

    // Update is called once per frame
    void Update()
    {
        
    }
}

很遗憾没整函数头部注释啊。等我下载完破解文件之后再来续。

恩，然后我下载了文件，点击exe进行安装，提醒我有2013和2017，继续安装，感到害怕，C盘快要红了····发现一件很神奇的事情，之前C盘就已经红了，最少的时候只有7个G可用，后来没管它也没删除什么东西，今天一看竟然有20个G可用。这是为什么？：