文件/资源命名规范

2019-1-5 19:00| 作者: admin| 查看: 5406| 评论: 1|来自: 蚂蚁部落

通过文件名称可以给使用者传达一些有用的信息。

由此可见,文件的命名也需要遵循一定的规则,否则不但无法顺畅传达信息,甚至可能会产生误解。

下面分布介绍一下文件命名需要遵循的一些约定俗成的规范。

一.构成名称的字符:

通常情况下,文件的名称是由英文字母、数字或者下划线构成,不能包含特殊字符或者汉字,且文件名称总是以字母开头,不能以数字开头。但有些时候,会刻意使用一些特殊字符作为文件名称的开头,以标识此文件具有特殊的功能,例如"_night-sky.scss",可以看到此scss文件名称是以下划线起始,说明它是一个局部文件。

关于SCSS局部文件可以参阅SCSS partial部分文件一章节。

二.名称大小写:

构成名称的字符使用小写形式。

还有一点需要特别说明,有一些操作系统对文件名称的大小是敏感的,如果大小写不同会被认作为不同的文件。

三.中划线作为分隔符:

对于文件的名称的命名,要尽量做到见词达意。

如果使用一个单词无法准确描述文件的功能,那么可以使用两个或者多个单词。

这时候推荐使用中划线,也就是减号(-)作为连字符,这是很常见的方式,很好理解。

代码实例如下:

[HTML] 纯文本查看 复制代码
//www.softwhy.com/images/big-bg.jpg

http(s)协议可以省略,本文不再介绍,具体参阅引入外部资源协议写法一章节。

四.文件名称中点的使用:

通常情况下点(.)的后面是文件的后缀,也就是文件的类型。

但并不总是这样,准确的说,应该是最后一个点的后面是文件类型,文件名称中可以有多个点。

此使用方式很常见,比如jquery.min.js,jquery表示文件的名称,第一个点后面的min表示此文件是压缩类型。

五.命名分析:

看如下几种文件命名方式:

[HTML] 纯文本查看 复制代码
antScript.js
antMainClass.css
ant_reg.html
88-script.js
ant-jquery-min.js

上面的都是不推荐方式,逐个分析如下:

(1).第一行问题在于,文件名称都中有大写字符,规范要求都是小写。

(2).第二行的问题与第一行相同。

(3).第三行使用下划线作为分隔符,要使用中划线分隔。

(4).第四行使用数字作为名称的开头,规范要求始终使用英文字符作为起始。

(5).第五行使用应该使用点替代中划线来分隔jquery与min,这种类似文件性质区分的建议使用点。

下面是对应的推荐命名方式:

[HTML] 纯文本查看 复制代码
ant-script.js
ant-main-class.css
ant-reg.html
script.js
ant-jquery.min.js

非常容易理解,不再进行分析,如果有任何问题可以在文章后面留言。


鲜花

握手

雷人

路过

鸡蛋
发表评论

最新评论

引用 gwdsss 2019-8-22 14:17
英文字母、数字或者下划线
且文件名称总是以字母开头,不能以数字开头
此scss文件名称是以下划线起始,说明它是一个局部文件
。参阅。
名称小写。
big-bg.jpg
横线。
http(s)协议可以省略,本文不再介绍,具体参阅引入外部资源协议写法一章节。
比如jquery.min.js,jquery表示文件的名称,第一个点后面的min表示此文件是压缩类型。
规范要求都是小写。
要使用中划线分隔。
使用英文字符作为起始。
这种类似文件性质区分的建议使用点。

查看全部评论(1)

返回顶部