视觉区分 auto-generated 个文件?

Visually distinguish auto-generated files?

我们有一堆 auto-generated 基于数据库模型的文件。我有过一些 facepalm 的经历,因为我修改了一些代码,却发现我的修改被覆盖了,因为我没有注意到我的更改在那些生成的文件中。

因此,我修改了我们的生成器以在文件 header 中包含一个 "do not modify" 注释。这有帮助!虽然,在跟踪方法调用时,很容易在这些文件之一的中间结束,除非您滚动到顶部检查 header,否则您不一定知道。这很尴尬(而且 error-prone)。

有什么方法可以标记这些文件,类似于标记 "External Libraries" 的方式,所以从样式上可以清楚地看出这些文件应该是 read-only?

命名约定是最好的 - 如果所有生成的文件都以 "GEN" 或其他东西为前缀,您会更快地注意到。

某些环境还允许您根据正则表达式为选项卡着色,因此您可以通过检测文件名中的前缀将它们全部设为黑色或粉红色。

.NET 堆栈对 C# 文件使用命名约定 *.designer.cs,例如,除了在第一行添加注释,说明该文件是使用自动化工具生成的以及任何更改重新生成文件会丢失

您可以使用 *.generated.php 作为文件命名模式,并包含一条注释 header 声明:

  • 文件由工具X生成,版本Y

  • 不要编辑此文件的源代码

  • 下次使用该工具时,对文件所做的任何更改都将丢失 运行

  • 将人们指向他们可以编辑的文件(如果适用)