Визуально различать автоматически созданные файлы?

Question

У нас есть куча файлов, которые автоматически генерируются на основе модели базы данных. У меня были некоторые проблемы с facepalm, потому что я модифицировал некоторый код, только чтобы узнать мои модификации, где перезаписано, потому что я не заметил, что мои изменения были в этих сгенерированных файлах.

Итак, я модифицировал наш генератор, чтобы включить комментарий «не изменять» в заголовке файла. Это помогает! Хотя при вызове метода трассировки легко попасть в середине одного из этих файлов, и вы не обязательно знаете, если не прокрутите вверх, чтобы проверить заголовок. Это неудобно (и подвержено ошибкам).

Есть ли способ отметить эти файлы так же, как «Внешние библиотеки» отмечены, так что из стилей ясно, что эти файлы должны быть доступны только для чтения?

Answer 1

Соглашение об именах является лучшим - если все сгенерированные файлы имеют префикс «GEN» или что-то еще, вы заметите гораздо быстрее.

В некоторых средах вы также можете покрасить вкладку на основе регулярного выражения, чтобы вы могли сделать их черными или розовыми, указав префикс в имени файла.

Answer 2

В стеке .NET используется соглашение об именах * .designer.cs для файлов C#, например, в дополнение к размещению комментария к первой строке, в котором говорится, что файл сгенерирован с использованием автоматизированного инструмента, и любые изменения будут потеряны если файл регенерирован.

Вы можете использовать * .generated.php в качестве файла шаблона именования, и включают в себя комментарий заголовок, который гласит:

• Файл генерируется инструментом X, версия Y

• Дон» т редактировать исходный код этого файла

• Любые изменения в файле будут потеряны в следующий раз инструмент запуска

• Точечные людей в файл они могут редактировать, удалять, если это применимо