Визуально отличить автоматически сгенерированные файлы?
У нас есть куча файлов, которые автоматически генерируются на основе модели базы данных. У меня были некоторые опыты с лицевой панелью, потому что я изменил некоторый код, только чтобы узнать, какие изменения были перезаписаны, потому что я не заметил, что мои изменения были в этих сгенерированных файлах.
Итак, я изменил наш генератор, добавив комментарий "не изменять" в заголовок файла. Это помогает! Хотя при трассировке вызовов методов легко оказаться в середине одного из этих файлов, и вы не обязательно узнаете, если не прокрутите вверх, чтобы проверить заголовок. Это неудобно (и подвержено ошибкам).
Есть ли способ пометить эти файлы аналогично тому, как помечаются "Внешние библиотеки", поэтому из стилей ясно, что эти файлы должны быть доступны только для чтения?
2 ответа
Соглашение об именовании лучше всего - если бы все сгенерированные файлы имели префикс "GEN" или что-то еще, вы заметили бы это намного быстрее.
В некоторых средах также можно раскрасить вкладку на основе регулярного выражения, поэтому это позволит вам сделать их все черными или розовыми, обнаружив префикс в имени файла.
Стек.NET использует соглашение об именах *.designer.cs для файлов C#, например, в дополнение к комментарию в первой строке, в котором говорится, что файл создан с использованием автоматического инструмента, и любые изменения будут потеряны, если файл регенерируется.
Вы можете использовать *.generated.php в качестве шаблона именования файлов и включить заголовок комментария, который гласит:
Файл сгенерирован инструментом X, версия Y
Не редактируйте исходный код этого файла
Любые изменения в файле будут потеряны при следующем запуске инструмента
Укажите людей на файл, который они могут редактировать, если это применимо