Конвенція про іменування файлів для зображень, що зберігаються в контролі версій?


9

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

  1. Тримайте назву файлу фіксованою, наприклад, application.ico
  2. Нехай ім'я файлу відображає характер зображення, наприклад, happyface.ico

У варіанті 1 не вказано, що таке файл. Це може дати ілюзію, що два диво різні зображення є якимось різними "версіями" одного і того ж. З варіантом 2, я не тільки повинен був би додати новий файл і видалити старий, я повинен був би змінити файл ресурсу, щоб відобразити нове ім'я файлу значка.

За спорідненим, але різним кутом:

Веб-сайт із зображенням заголовка. Це ім'я файлу header.jpg або sunrise-family-smile.jpg?

Чи повинні назви файлів зображень відображати їх функцію в програмі чи вмісті? Що було б найкращою практикою для цього?

Відповіді:


11

У варіанті 1 не вказано, що таке файл. Це може дати ілюзію, що два диво різні зображення є якимось різними "версіями" одного і того ж

Ну, так, чи не так? Я знаю, що це могло змінитися від смайлика до корпоративного логотипу, але це все ще різні версії певної піктограми у вашій програмі.

Я думаю, що ви пропускаєте суть, зосередившись на підриві. Основним вирішальним фактором повинна бути сама програма. Коли я додаю піктограму, що з’являється в заголовку, я не замислююся над тим, що "я повинен описати зміст зображення". Я думаю, "що це за зображення в додатку чи комусь іншому, кому потрібно його змінити пізніше?"

І в цьому криється більший момент. Коли я прийду його змінити пізніше, чи дійсно я хочу змінити назву зображення в додатку? Він все одно робить те саме, тож чому програма повинна знати, що я змінив її?


4

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

У вашому випадку я б насправді взяв третій вибір:

  • Якби додаток називався XYZZY, я б назвав піктограму програми "XYZZY.ico". Незалежно від того, як виглядає значок, це правильна ікона для програми XYZZY.

За розширенням, якби мені знадобилося кілька піктограм різного розміру, я б додав розмір піктограми до імені. Отже для піктограми розміром 48x48 я мав би "XYZZY_48x48.ico".

Стосовно останньої частини "Веб-сайт із зображенням заголовка. Чи є ім'я файлу header.jpg або sunrise-family-smile.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.