直观地区分自动生成的文件?

时间:2017-01-27 13:14:42

标签: php code-generation phpstorm

我们有一堆基于数据库模型自动生成的文件。我有一些facepalm经验,因为我修改了一些代码,只是为了找到我的修改被覆盖,因为我没有注意到我的更改是在那些生成的文件中。

因此,我修改了我们的生成器,在文件头中包含“不要修改”注释。这有帮助!虽然,在跟踪方法调用时,很容易在其中一个文件的中间结束,除非你滚动到顶部检查标题,否则你不一定知道。这很尴尬(而且容易出错)。

有没有办法标记这些文件,就像标记“外部库”一样,所以从样式中可以清楚地看出这些文件应该是只读的?

2 个答案:

答案 0 :(得分:3)

命名约定是最好的 - 如果所有生成的文件都以“GEN”为前缀,你会注意到更快。

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

答案 1 :(得分:3)

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

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

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

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

  • 下次运行工具时,文件的任何更改都将丢失

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