檔案/資源命名規範

admin發表於2019-01-05

通過檔名稱可以給使用者傳達一些有用的資訊。

檔案命名需要遵循一定的規則,否則不但無法順暢傳達資訊,甚至可能會產生誤解。

下面分步介紹一下檔案命名需要遵循的一些約定俗成的規範。

一.構成名稱的字元:

通常情況下,檔名稱由英文字母、數字或者下劃線構成,不能包含特殊字元或者漢字,且檔名稱總是以字母開頭,不能以數字開頭。但有些時候,會刻意使用一些特殊字元作為檔名稱的開頭,以標識此檔案具有特殊的功能,例如"_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

非常容易理解,不再進行分析,如果有任何問題可以在文章後面留言。

相關文章