Соглашение об именовании файлов для изображений, хранящихся в системе управления версиями?


9

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

  1. Сохраняйте имя файла фиксированным, например, application.ico
  2. Пусть имя файла отражает характер изображения, например happyface.ico

Вариант 1 не говорит, что это за файл. Это может создать иллюзию того, что два совершенно разных изображения - это разные «версии» одного и того же. При выборе варианта 2 мне нужно будет не только добавить новый файл и удалить старый, но и изменить файл ресурсов, чтобы отразить новое имя файла значка.

Под другим, но другим углом:

Сайт с изображением заголовка. Это имя файла header.jpg или sunrise-family-smiling.jpg?

Должны ли имена файлов изображений отражать их функцию в приложении или их содержимое? Что было бы лучшим для этого?

Ответы:


11

Вариант 1 не говорит, что это за файл. Это может создать иллюзию того, что два совершенно разных изображения - это разные «версии» одного и того же.

Ну, не так ли? Я знаю, что он мог смениться со смайлика на корпоративный логотип, но все же это разные версии определенного значка в вашем приложении.

Я думаю, что вы упускаете суть, сосредоточившись на подрывной деятельности. Ключевым решающим фактором должно быть само приложение. Когда я добавляю значок, который появляется в строке заголовка, я не думаю, что «я должен описать содержание изображения». Я думаю: «Что это за изображение для приложения или для кого-то еще, кому необходимо изменить его позже?»

И в этом заключается большая точка. Когда я приду, чтобы изменить это позже, я действительно хочу изменить имя изображения в приложении? Он все еще делает то же самое, так почему приложение должно знать, что я его изменил?


4

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

В вашем случае я бы выбрал третий вариант:

  • Если бы приложение называлось XYZZY, я бы назвал значок приложения «XYZZY.ico». Независимо от того, как выглядит значок, это правильный значок для приложения XYZZY.

К тому же, если бы мне понадобилась пара значков разных размеров, я бы добавил к значку размер значка. Поэтому для значка 48x48 у меня будет «XYZZY_48x48.ico».

В отношении последней части «Веб-сайт с изображением заголовка. Это имя файла header.jpg или sunrise-family-smiling.jpg?»: Если веб-сайт предназначен для Plugh Corp, то я бы использовал «Plugh_Header.jpg».


3
Добавление имени приложения к имени файла немного избыточно, так как все файлы будут обязательно находиться в папке с именем XYZZY, и, следовательно, можно определить компанию. Вы называете домашнюю страницу XYZZY_index.htm? Тогда зачем делать это для изображений?
Гэвин Коутс

4

Я бы пошел application.icoи header.jpgкак это проще и ближе к значению изображения в вашем приложении .

Возможно, вы захотите хранить изображения как happyface.icoи sunrise-family-smiling.jpgгде-либо еще (в другом репо или, может быть, в том же самом), если вы хотите, чтобы они также были легко доступны.


2

Следует иметь в виду еще одну вещь: если это веб-приложение, вам нужно изменить имя файла, даже если изображение не изменилось принципиально просто потому, что браузеры пользователей загружают новую версию, а не используют старую версию из кэш.

Из лучших практик Yahoo по ускорению вашего сайта :

Имейте в виду, что если вы используете заголовок Expires далекого будущего, вы должны изменять имя файла компонента при каждом изменении компонента. В Yahoo! мы часто делаем этот шаг частью процесса сборки: номер версии встроен в имя файла компонента, например, yahoo_2.0.6.js.

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.