Konwencja nazewnictwa plików dla obrazów przechowywanych w kontroli wersji?

9

Moja aplikacja ma plik ikon, który jest przechowywany w kontroli wersji. Teraz jutro mogę zdecydować o zmianie ikony. Omawiam dwie możliwe konwencje nazewnictwa dla pliku ikony:

  1. Zachowaj nazwę pliku, np. Application.ico
  2. Niech nazwa pliku odzwierciedla charakter obrazu, np. Happyface.ico

Opcja 1 nie mówi, jaki jest plik. Mogłoby to dać złudzenie, że dwa skrajnie różne obrazy są w jakiś sposób różnymi „wersjami” tej samej rzeczy. W przypadku opcji 2 musiałbym nie tylko dodać nowy plik i usunąć stary, ale musiałbym zmodyfikować plik zasobów, aby odzwierciedlał nową nazwę pliku ikony.

Pod pokrewnym, ale innym kątem:

Witryna z obrazem nagłówka. Czy nazwa pliku header.jpg lub sunrise-family-smiling.jpg?

Czy nazwy plików obrazów powinny odzwierciedlać ich funkcję w aplikacji lub ich zawartość? Jaka byłaby najlepsza praktyka w tym zakresie?

Użytkownik
źródło

Odpowiedzi:

11

Opcja 1 nie mówi, jaki jest plik. Mogłoby to dać złudzenie, że dwa skrajnie różne obrazy są w jakiś sposób różnymi „wersjami” tej samej rzeczy

Cóż, prawda? Wiem, że zmieniło się to z uśmiechniętej buźki na firmowe logo, ale wciąż są to różne wersje konkretnej ikony w Twojej aplikacji.

Myślę, że nie rozumiesz tego, koncentrując się na subwersji. Kluczowym czynnikiem decydującym powinna być sama aplikacja. Kiedy dodam ikonę, która pojawia się na pasku tytułu, nie myślę „Muszę opisać zawartość obrazu”. Zastanawiam się „co to jest ten obraz dla aplikacji lub kogokolwiek, kto musi go później zmienić?”

I na tym polega większy punkt. Czy kiedy chcę to zmienić później, naprawdę chcę zmienić nazwę obrazu w aplikacji? Nadal robi to samo, więc dlaczego aplikacja musi wiedzieć, że to zmieniłem?

pdr
źródło
4

Osobiście zawsze używałem opisowej nazwy dla wszystkich moich plików, w tym ikon, a nawet jeśli nazwy zasobów muszą zostać zmienione.

W twoim przypadku wybrałbym trzeci wybór:

  • Gdyby aplikacja nazywała się XYZZY, nazwałbym ikonę aplikacji „XYZZY.ico”. Bez względu na to, jak wygląda ikona, jest to właściwa ikona dla aplikacji XYZZY.

Co więcej, gdybym potrzebował kilku ikon o różnych rozmiarach, dodałbym rozmiar ikony do nazwy. Tak więc dla ikony 48x48 miałbym „XYZZY_48x48.ico”.

W odniesieniu do ostatniej części „Witryna z obrazem nagłówka. Czy nazwa pliku header.jpg czy sunrise-family-smiling.jpg?”: Jeśli strona jest dla Plugh Corp, użyłbym „Plugh_Header.jpg”.

jwernerny
źródło
3
Dodanie nazwy aplikacji do nazwy pliku jest nieco zbędne, ponieważ z pewnością wszystkie pliki będą znajdować się w folderze o nazwie XYZZY, a zatem można na podstawie tego ustalić firmę. Czy nazywasz stronę główną XYZZY_index.htm? Dlaczego więc robisz to dla obrazów?
Gavin Coates
4

Wybrałbym, application.icoa header.jpgponieważ jest to prostsze i bliższe znaczeniu obrazu w twojej aplikacji .

Możesz przechowywać obrazy jako happyface.icoi sunrise-family-smiling.jpggdzie indziej (w innym repozytorium lub może w tym samym), jeśli chcesz, aby były one również łatwo dostępne.

maaartinus
źródło
2

Kolejną rzeczą do zapamiętania: jeśli jest to aplikacja internetowa, będziesz chciał zmienić nazwę pliku, nawet jeśli obraz nie zmieni się zasadniczo po prostu dlatego, że zmusza to przeglądarki użytkowników do załadowania nowej wersji zamiast używania starej z Pamięć podręczna.

Z najlepszych praktyk Yahoo dotyczących przyspieszenia witryny :

Pamiętaj, że jeśli używasz nagłówka Expires o dalekiej przyszłości, musisz zmienić nazwę pliku komponentu za każdym razem, gdy zmienia się komponent. W Yahoo! często robimy ten krok częścią procesu kompilacji: numer wersji jest osadzony w nazwie pliku komponentu, na przykład yahoo_2.0.6.js.

Michael Borgwardt
źródło