10个程序员写代码只有1个加头注?加上整齐的代码头注,你也是那10分之1

恬静的小魔龙 发表于 2022/05/26 13:20:35 2022/05/26
【摘要】 推荐阅读CSDN主页GitHub开源地址Unity3D插件分享简书地址我的个人博客QQ群:1040082875 一、前言有些代码,会在代码的头部写上一大堆的注释:(1)说明这是谁写的(2)什么时候创建的(3)什么版本(4)什么作用(5)版本变更时间这样就可以很清晰的看到这个脚本是谁写的,写了什么,变更的时间版本等,利于开发。总是总是写一个脚本,复制过去,改一下,也感觉有些繁琐。接下来就教大家...

推荐阅读

一、前言

有些代码,会在代码的头部写上一大堆的注释:

(1)说明这是谁写的

(2)什么时候创建的

(3)什么版本

(4)什么作用

(5)版本变更时间

这样就可以很清晰的看到这个脚本是谁写的,写了什么,变更的时间版本等,利于开发。

总是总是写一个脚本,复制过去,改一下,也感觉有些繁琐。

接下来就教大家如何自动为脚本添加头注。

二、实现

using System.IO;

namespace Editor
{
    /// <summary>
    /// 创建脚本自动添加头注
    /// </summary>
    public class FirstComment : UnityEditor.AssetModificationProcessor
    {
        /// <summary>
        /// 在资源创建生成.meta时调用
        /// </summary>
        /// <param name="path">自动传入资源路径</param>
        public static void OnWillCreateAsset(string path)
        {
            path = path.Replace(".meta", "");
            if (!path.EndsWith(".cs")) return;
            string allText = "// ========================================================\r\n"
                             + "// 描述:\r\n"
                             + "// 功能:\r\n"
                             + "// 作者:XXX \r\n"
                             + "// 创建时间:#CreateTime#\r\n"
                             + "// 版本:1.0\r\n"
                             + "// 变更时间:\r\n"
                             + "// 变更版本:#CreateTime2#\r\n"
                             + "// 脚本路径:#ScripsPath#\r\n"
                             + "// ========================================================\r\n";
            allText += File.ReadAllText(path);
            allText =  allText.Replace("#CreateTime#", System.DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"));
            allText = allText.Replace("#ScripsPath#", path);
            File.WriteAllText(path, allText);
        }
    }
}

效果图:
在这里插入图片描述

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区),文章链接,文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件至:cloudbbs@huaweicloud.com进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容。
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。