【100个Cocos实例】编码不规范，接手泪两行...
点击上方亿元程序员+关注和★星标。
引言
规范编码，从文件头部注释规范做起。
头部注释规范是一种在代码文件开头添加注释信息的做法，通常用于描述文件的基本信息、作者、创建日期、修改历史等。
这有助于团队成员更好地理解和维护代码。
本文将介绍一下在Cocos游戏开发中如何更方便地添加文件头部注释。
1.亲身经历
不知道小伙伴们有没有这样的两种经历：
第一种是在Cocos2.X的项目开发中，我们每次在Creator中创建一个新脚本的时候，如下图：
都会有一些我们不需要的一些内容生成，如顶部的一些学习导航、中间默认的cc.Label和string属性，还有我们可能会用到的onLoad和update方法。每次我们都需要手动去删掉这些内容，对于有强迫症的小伙伴来说，真是苦不堪言。
第二种则是在Cocos3.X的项目开发中，官方也算是考虑到强迫症的我们，新创建的脚本非常整洁，只有start和update方法，而且还非常贴心地帮我们把组件的名字修改成与创建时一致。
但是万万没想到，项目为了规范，必须要我们在头部添加注释规范。想起一句话：“上帝为你开了一扇窗，必定会关掉你的门”。
那么问题来了，如何解决上述问题？
2.修改默认模板
其实引擎在为我们生成新的脚本的时候，都会遵循一个默认的模板，因此只要我们找到这个模板，我们就可以通过修改它达到我们想要的目的。
1.安装目录
首先我们可以打开我们的仪表板Cocos Dashboard，在里面我们可以清楚地看到我们电脑上安装的所有的Cocos版本：
然后我们可以通过引擎右边的···选择在资源管理器中显示打开我们Cocos安装到的目录，然后找到我们的模板文件：
2.x版本的模板文件目录如下：
resources\static\template
3.x版本的模板文件目录如下：
resources\resources\3d\engine\editor\assets\default_file_content
2.修改模板内容
2.x版本我们打开模板文件new-script.ts，可以看到它和我们上面生成的脚本一模一样，所以它仅仅只是把模板文件帮我们拷贝到项目里面去：
因此我们只需要把我们不需要默认生成的内容删掉，或者我们想要它默认生成的内容添加上去即可：
3.x版本我们打开模板文件ts，可以看到它我们上面生成的脚本也差不多一致。
唯一不同的地方是上面有<%UnderscoreCaseClassName%>字样，这是帮我们自动修改组件名的关键，下面有相关的介绍：
简单介绍一下主要包含几种动态生成的数据，写入下面的内容，系统会自动帮忙动态替换成具体的内容：
<%UnderscoreCaseClassName%>:下划线类名，这个和新建的类名一致。<%CamelCaseClassName%>:驼峰类名，这个会自动帮我们把类名首字母大写。<%Author%>：作者，我们Cocos登陆的用户名。<%DateTime%>：日期，当前时间。<%FileBasename%>：文件名，创建的脚本文件的名字。<%FileBasenameNoExtension%>：文件名(无后缀)，创建的脚本文件的名字(无后缀)。<%URL%>：url，指向assets。<%ManualUrl%>：帮助文档url，指向帮助文档链接。
最终修改如下，使用到了动态文件名、作者和时间：
一般文件头部应该要注释哪些内容？
3.文件头部注释规范
以下是一些常见的头部注释规范元素及其解释：
Copyright：版权信息，可以是公司或者个人。File name：文件名，脚本/组件的文件名。Description：描述，脚本/组件的功能描述或者其他的一些相关介绍。Author：作者，脚本/组件的作者。Version：版本，脚本/组件修改迭代的版本。Date：日期，一般是脚本/组件的完成日期，也可以是开始日期。History：历史，修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。
4.效果演示
2.x版本的效果演示如下：
3.x版本的效果演示如下：
结语
时间宝贵，只有极致地减少流水线工作，才有更多时间去做我们要做的。
在哪里可以看到如此清晰的思路，快跟上我的节奏！关注我，和我一起了解游戏行业最新动态，学习游戏开发技巧。
我是"亿元程序员"，一位有着8年游戏行业经验的主程。在游戏开发中，希望能给到您帮助, 也希望通过您能帮助到大家。
AD:笔者线上的小游戏《贪吃蛇掌机经典》《重力迷宫球》《填色之旅》大家可以自行点击搜索体验。
实不相瞒，想要个赞和在看！请把该文章分享给你觉得有需要的其他小伙伴。谢谢！
推荐专栏：
你知道王者荣耀是怎么实现技能范围指示器的吗？
8年主程手把手打造Cocos独立游戏开发框架
和8年游戏主程一起学习设计模式
从零开始开发贪吃蛇小游戏到上线系列
点击下方绿色按钮+关注。