Quy ước đặt tên tệp cho hình ảnh được lưu trữ trong kiểm soát phiên bản?


9

Ứng dụng của tôi có một tệp biểu tượng được lưu trữ trong kiểm soát phiên bản. Bây giờ ngày mai tôi có thể quyết định thay đổi biểu tượng. Tôi đang tranh luận giữa hai quy ước đặt tên có thể có cho tệp biểu tượng:

  1. Giữ tên tệp cố định, ví dụ: application.ico
  2. Có tên tệp phản ánh bản chất của hình ảnh, ví dụ: happyface.ico

Tùy chọn 1 không cho biết tập tin là gì. Nó có thể tạo ảo giác rằng hai hình ảnh cực kỳ khác nhau là "phiên bản" khác nhau của cùng một thứ. Với tùy chọn 2, tôi không chỉ phải thêm một tệp mới và xóa tệp cũ, tôi phải sửa đổi tệp tài nguyên để phản ánh tên tệp biểu tượng mới.

Trên một góc độ liên quan nhưng khác nhau:

Một trang web với một hình ảnh tiêu đề. Là tên tệp header.jpg hoặc sunawn-Family-smile.jpg?

Tên tệp hình ảnh phản ánh chức năng của chúng trong ứng dụng hoặc nội dung của chúng? Điều gì sẽ là một thực hành tốt nhất cho điều này?

Câu trả lời:


11

Tùy chọn 1 không cho biết tập tin là gì. Nó có thể tạo ảo giác rằng hai hình ảnh cực kỳ khác nhau là "phiên bản" khác nhau của cùng một thứ

Vâng, nó là, phải không? Tôi biết rằng nó có thể đã thay đổi từ mặt cười thành logo của công ty, nhưng nó vẫn là các phiên bản khác nhau của một biểu tượng cụ thể trong ứng dụng của bạn.

Tôi nghĩ rằng bạn đang thiếu điểm bằng cách tập trung vào lật đổ. Yếu tố quyết định chính là ứng dụng. Khi tôi thêm biểu tượng xuất hiện trên thanh tiêu đề, tôi không nghĩ "Tôi phải mô tả nội dung của hình ảnh." Tôi đang nghĩ "hình ảnh này cho ứng dụng là gì, hoặc cho bất kỳ ai khác cần thay đổi nó sau này?"

Và trong đó có một điểm lớn hơn. Khi tôi đến để thay đổi nó sau này, tôi có thực sự muốn thay đổi tên của hình ảnh trong ứng dụng không? Nó vẫn đang làm điều tương tự, vậy tại sao ứng dụng cần biết tôi đã thay đổi nó?


4

Cá nhân, tôi đã luôn sử dụng một tên mô tả cho tất cả các tệp của mình, bao gồm các biểu tượng và ngay cả khi tên tài nguyên đó phải được thay đổi.

Trong trường hợp của bạn, tôi thực sự sẽ có một lựa chọn thứ ba:

  • Nếu ứng dụng được gọi là XYZZY, thì tôi sẽ đặt tên cho biểu tượng cho ứng dụng "XYZZY.ico". Bất kể biểu tượng trông như thế nào, nó là biểu tượng thích hợp cho ứng dụng XYZZY.

Theo tiện ích mở rộng, nếu tôi cần một vài biểu tượng có kích thước khác nhau, tôi sẽ thêm kích thước của biểu tượng vào tên. Vì vậy, đối với biểu tượng 48x48, tôi sẽ có "XYZZY_48x48.ico".

Liên quan đến phần cuối cùng "Một trang web có hình ảnh tiêu đề. Là tên tệp header.jpg hoặc sunawn-family-smile.jpg?": Nếu trang web này dành cho Plugh Corp, thì tôi sẽ sử dụng "Plugh_Header.jpg".


3
Việc thêm tên của ứng dụng vào tên tệp là hơi dư thừa, vì chắc chắn tất cả các tệp sẽ nằm trong một thư mục có tên XYZZY, và do đó công ty có thể được xác định từ đó. Bạn có đặt tên cho trang chủ XYZZY_index.htm không? Vậy thì tại sao lại làm như vậy cho hình ảnh?
Gavin Coates

4

Tôi muốn application.icoheader.jpgvì nó đơn giản và gần với ý nghĩa hình ảnh trong ứng dụng của bạn .

Bạn có thể muốn lưu trữ hình ảnh như happyface.icosunrise-family-smiling.jpgở một nơi khác (trong một repo khác hoặc có thể giống nhau) nếu bạn muốn giữ chúng dễ dàng truy cập, quá.


2

Một lưu ý khác: nếu đây là một ứng dụng web, bạn sẽ muốn thay đổi tên tệp ngay cả khi hình ảnh không thay đổi về cơ bản chỉ vì điều đó buộc trình duyệt của người dùng tải phiên bản mới thay vì sử dụng phiên bản cũ từ bộ nhớ cache.

Từ thực tiễn tốt nhất của Yahoo để tăng tốc trang web của bạn :

Hãy ghi nhớ, nếu bạn sử dụng tiêu đề Hết hạn trong tương lai xa, bạn phải thay đổi tên tệp của thành phần bất cứ khi nào thành phần thay đổi. Tại Yahoo! chúng tôi thường biến bước này thành một phần của quá trình xây dựng: số phiên bản được nhúng trong tên tệp của thành phần, ví dụ: yahoo_2.0.6.js.

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.