版本控制中存储的图像的文件命名约定?


9

我的应用程序有一个存储在版本控制中的图标文件。现在明天我可能决定更改图标。我正在讨论图标文件的两种可能的命名约定:

  1. 保持文件名固定,例如application.ico
  2. 使文件名反映图像的性质,例如happyface.ico

选项1没有说明文件是什么。它可能会给人一种错觉,即两个完全不同的图像是同一事物的不同“版本”。使用选项2,我不仅必须添加一个新文件并删除旧文件,而且还必须修改资源文件以反映新图标的文件名。

从一个相关但不同的角度来看:

一个带有标题图像的网站。文件名是header.jpg还是Sunrise-family-smiling.jpg?

图像文件名是否应反映其在应用程序中的功能或内容?最佳做法是什么?

Answers:


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.icoheader.jpg因为它更简单,更接近您应用程序中的图像含义

您可能希望存储的图像以happyface.icosunrise-family-smiling.jpg其他地方(在另一个回购或可能在同一个),如果你想要让他们方便了。


2

要记住的另一件事:如果这是一个Web应用程序,即使图像没有根本改变,您也将要更改文件名,这仅仅是因为这迫使用户的浏览器加载新版本而不是使用旧版本。缓存。

摘自Yahoo 加快网站访问最佳做法

请记住,如果使用远期的Expires标头,则每当组件更改时,都必须更改组件的文件名。在雅虎!我们通常将此步骤作为构建过程的一部分:版本号嵌入在组件的文件名中,例如yahoo_2.0.6.js。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.