文件命名規(guī)范

整體思想:

(1)機(jī)器可讀
(2)人可讀
(3)排序與默認(rèn)排序類似
部分原則:
(1)名字不帶空格
(2)最好不大小寫敏感宾舅,所有文件都轉(zhuǎn)換成大寫或者小寫后薪鹦,不能有重名文件若厚;
(3)連字符采用統(tǒng)一標(biāo)準(zhǔn)裙士,例如心剥,下劃線(_)表示part征堪,而中短橫線(-)表明這是一個(gè)part瘩缆,例如多個(gè)單詞的名字;

Tips for naming:

思考你的文件佃蚜,想想你的文件是關(guān)于什么的庸娱?

  1. 你的文件命名可以涵蓋哪些文件組(group);
  2. 對(duì)于不同的文件集可以使用不用的命名規(guī)格
  3. 檢查你的研究組和研究學(xué)科里中已經(jīng)建立的命名規(guī)則
    例如谐算,建立一個(gè)可以描述所有顯微圖片的命名規(guī)范熟尉,包含了原始圖片和加工后的圖片。

檢查metadata洲脂,例如時(shí)間斤儿、樣本、實(shí)驗(yàn)恐锦,思考如何簡(jiǎn)單快速的定位特定文件需要什么信息

電腦根據(jù)文件名進(jìn)行排序(字母順序)往果,因此,最重要的信息要放到最前面一铅,例如陕贮,你預(yù)計(jì)你要根據(jù)日期找文件,則把日期寫在最前面

  1. 文件名應(yīng)該具有描述性并且提供足夠的內(nèi)容信息潘飘。
    例如肮之,可以將下面的信息結(jié)合起來:
    實(shí)驗(yàn)條件
    數(shù)據(jù)類型
    研究者
    實(shí)驗(yàn)室名字
    項(xiàng)目名字
  2. 實(shí)驗(yàn)室日期或者范圍(range),例如使用YYYYMMDD卜录,這樣可以使得文件具有編年史順序局骤。未來加入時(shí)間戳,可以使用YYYYMMDDThhmm暴凑,即通過T進(jìn)行時(shí)間隔斷。
  3. 實(shí)驗(yàn)號(hào)或者樣品號(hào)
    對(duì)于連續(xù)編號(hào)系統(tǒng)赘来,使用前導(dǎo)的0作為起始现喳,來確保清晰和保證文件處于正確的序列凯傲。應(yīng)該使用"001, 002, ...010, 011 ... 100, 101 ..." 而不是 "1, 2, ...10, 11 ... 100, 101 ..."

簡(jiǎn)寫或者metadata編碼

不要忘記文件編碼格式!

決定哪些短短信息被保留

標(biāo)準(zhǔn)化類別和/或用2或3個(gè)字母的代碼替換它們
確保記錄這些編碼信息

例子:
Project id使用2個(gè)字符嗦篱,p1冰单,p2
物種id用三個(gè)字符,mouse=MUS灸促, fruit fly=DRS
樣本id用三個(gè)字符诫欠;

使用版本號(hào)

你是否需要維持對(duì)于同一文件維持不同版本號(hào)

使用版本管理來表明文件的最新版本
通過在文件名的末尾添加版本信息來跟蹤文件的版本,例如:文件名_v2.xxx
使用版本號(hào)(例如:"v01 "或 "v02")浴栽。
使用版本日期(使用ISO 8601格式:YYYMMDD或YYY-MM-DD)荒叼。

思考你如何搜索你的文件

對(duì)于metadata和文件的排序,思考你想如何排序和搜索你的文件典鸡;
決定metadata如何出現(xiàn)在開始
使用默認(rèn)的排序:字母 數(shù)字 日期
使用ISO 8601-formatted dates (YYYYMMDD or YYYY-MM-DD)

分隔metadata數(shù)據(jù)

文件名中避免使用空格和特殊字符被廓,因?yàn)楹芏嚯娔X系統(tǒng)并不能很好的處理帶有空格的文件名,所以不要使用空格萝玷!
? 使用 dashes (-), underscores (_)嫁乘,或者每個(gè)單詞的首字母大寫
? Dashes: file-name.xxx
? Underscores: file_name.xxx
? No separation: filename.xxx(介詞一般不大寫,例如in of)
? 使用駝峰標(biāo)記 (每個(gè)部分的首字母大寫): FileName.xxx
? 避免使用特殊字符球碉,例如: ~ ! @ # $ % ^ & * ( ) ` ; : < > ? . , [ ] { } ' " |

寫下你的命名規(guī)則

同時(shí)蜓斧,也應(yīng)在最頂層寫一個(gè)README文件來描述你的文件結(jié)構(gòu);
? 如果文件被移動(dòng)了或者被分享了睁冬,使用者應(yīng)該能通過文件名識(shí)別該文件挎春;
? 文件名應(yīng)該只使用字母,短橫線痴突,下劃線搂蜓,一般少于50字符
? 如果你發(fā)現(xiàn)文件名中編碼了大量metadata,那么你應(yīng)該考慮將這些元數(shù)據(jù)與你的數(shù)據(jù)一起存儲(chǔ)在主表格中辽装,以便將來參考帮碰。
例如:我的文件命名格式為
[SA-MPL-EID][YYYYMMDD][###]_[status].[tif]

參考:
https://datamanagement.hms.harvard.edu/collect/file-naming-conventions

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市拾积,隨后出現(xiàn)的幾起案子殉挽,更是在濱河造成了極大的恐慌,老刑警劉巖拓巧,帶你破解...
    沈念sama閱讀 206,839評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件斯碌,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡肛度,警方通過查閱死者的電腦和手機(jī)傻唾,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人冠骄,你說我怎么就攤上這事伪煤。” “怎么了凛辣?”我有些...
    開封第一講書人閱讀 153,116評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵抱既,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我扁誓,道長(zhǎng)防泵,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,371評(píng)論 1 279
  • 正文 為了忘掉前任蝗敢,我火速辦了婚禮捷泞,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘前普。我一直安慰自己肚邢,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,384評(píng)論 5 374
  • 文/花漫 我一把揭開白布拭卿。 她就那樣靜靜地躺著骡湖,像睡著了一般。 火紅的嫁衣襯著肌膚如雪峻厚。 梳的紋絲不亂的頭發(fā)上响蕴,一...
    開封第一講書人閱讀 49,111評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音惠桃,去河邊找鬼浦夷。 笑死,一個(gè)胖子當(dāng)著我的面吹牛辜王,可吹牛的內(nèi)容都是我干的劈狐。 我是一名探鬼主播,決...
    沈念sama閱讀 38,416評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼呐馆,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼肥缔!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起汹来,我...
    開封第一講書人閱讀 37,053評(píng)論 0 259
  • 序言:老撾萬榮一對(duì)情侶失蹤续膳,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后收班,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體坟岔,經(jīng)...
    沈念sama閱讀 43,558評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,007評(píng)論 2 325
  • 正文 我和宋清朗相戀三年摔桦,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了社付。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,117評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖瘦穆,靈堂內(nèi)的尸體忽然破棺而出纪隙,到底是詐尸還是另有隱情,我是刑警寧澤扛或,帶...
    沈念sama閱讀 33,756評(píng)論 4 324
  • 正文 年R本政府宣布,位于F島的核電站碘饼,受9級(jí)特大地震影響熙兔,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜艾恼,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,324評(píng)論 3 307
  • 文/蒙蒙 一住涉、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧钠绍,春花似錦舆声、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,315評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至磷脯,卻和暖如春蛾找,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背赵誓。 一陣腳步聲響...
    開封第一講書人閱讀 31,539評(píng)論 1 262
  • 我被黑心中介騙來泰國(guó)打工打毛, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人俩功。 一個(gè)月前我還...
    沈念sama閱讀 45,578評(píng)論 2 355
  • 正文 我出身青樓幻枉,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親诡蜓。 傳聞我的和親對(duì)象是個(gè)殘疾皇子熬甫,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,877評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容

  • 上傳文件的命名規(guī)范用于確保文件不會(huì)產(chǎn)生沖突或者覆蓋的情況。而命名規(guī)范的定義又需要根據(jù)你的業(yè)務(wù)邏輯來調(diào)整万牺,不是固定的...
    hello大象閱讀 4,626評(píng)論 0 1
  • 為了降低設(shè)計(jì)和開發(fā)之間的交流成本罗珍,所以在此確定一下 iOS 項(xiàng)目切圖的命名標(biāo)準(zhǔn)。 我們的命名規(guī)則的基本思想是把文件...
    offspring閱讀 15,910評(píng)論 6 46
  • 通過本節(jié)課的學(xué)習(xí)脚粟,您可以: 做到規(guī)范命名電腦上的文件和文件夾為今后的快捷搜索(使用Everything)做好準(zhǔn)備 ...
    仔爸在線閱讀 3,327評(píng)論 0 3
  • 文件或文件夾的命名遵循以下原則: index.js 或者 index.vue覆旱,統(tǒng)一使用小寫字母開頭的(kebab-...
    CodeMT閱讀 4,892評(píng)論 0 4
  • 文件夾命名 超過一個(gè)單詞的統(tǒng)一使用小寫字母開頭的(kebab-case)命名規(guī)范 ,如 shop-setting ...
    華圣靈魂閱讀 4,380評(píng)論 0 0