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

简介: 有些代码,会在代码的头部写上一大堆的注释:(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);
        }
    }
}
复制代码

效果图:

网络异常,图片无法展示
|



相关文章
|
5月前
|
设计模式 算法 前端开发
有什么可以减少注释,但依然能让他人看得懂代码的方法吗?
有什么可以减少注释,但依然能让他人看得懂代码的方法吗?
30 0
|
3月前
|
存储 编译器 程序员
近4w字吐血整理!只要你认真看完【C++编程核心知识】分分钟吊打面试官(包含:内存、函数、引用、类与对象、文件操作)
近4w字吐血整理!只要你认真看完【C++编程核心知识】分分钟吊打面试官(包含:内存、函数、引用、类与对象、文件操作)
109 0
|
4月前
|
设计模式 算法 Java
|
9月前
循环初级一(附小练习和详细代码答案)
循环初级一(附小练习和详细代码答案)
74 0
|
7月前
|
机器学习/深度学习 算法 搜索推荐
程序员的算法“必抓清单”:那些我们一定会遇见的算法
程序员的算法“必抓清单”:那些我们一定会遇见的算法
39 0
|
9月前
循环初级二(附小练习及其代码答案)
循环初级二(附小练习及其代码答案)
46 0
|
11月前
|
程序员
什么是好代码/坏代码?给普通人的图解示例
什么是好代码/坏代码?给普通人的图解示例
79 0
|
Linux
L1-1 嫑废话上代码 (5分)
L1-1 嫑废话上代码 题解
60 0
|
Linux
L1-065 嫑废话上代码 (5 分)
L1-065 嫑废话上代码 (5 分)
76 0
|
开发框架 缓存 监控
测试是否有必要看开发代码?如何能看懂?
测试是否有必要看开发代码?如何能看懂?