代碼的文件和路徑命名規(guī)范和目錄結(jié)構(gòu)規(guī)劃

簡介

環(huán)境一搭好一般都不大好改動路徑文件夾和文件名稱,所以規(guī)范些比較好。

規(guī)則經(jīng)驗(yàn)

文件、文件夾命名法

  • 用字母或下劃線_開頭的駝峰命名法,比較特有的名稱用大駝峰命名法(A51、PHP、VHDL、Altera、Intellij、CLion),通用和常見的名稱用小駝峰命名法(env、pro)。不要用中文或特殊字符,如“ ” & - 空格等(空格在指令或代碼編輯器里經(jīng)常要加轉(zhuǎn)義符\ 麻煩),因?yàn)槲覀冏詈靡龅絎indows Linux Mac等跨平臺通用(比如有種情況,zip文件在跨平臺解壓時有些文件名不符系統(tǒng)規(guī)則導(dǎo)致無法解壓),且大多有些舊硬件開發(fā)工具不支持中文路徑,及如AndroidStudio中資源文件命名要求等原因,所以名稱最好最好都 只含英文字母、下劃線、數(shù)字,并只用字母或下劃線開頭。另外,c++帶有特殊字符+,偶爾必要時可用cppcxx命名代替。
  • 文件文件夾名稱盡量短,原因之一:有些開發(fā)工具對路徑長度要求128B內(nèi)甚至更短,之二:比較容易看。
    例如C:\Code\XX\下放開發(fā)環(huán)境相關(guān)配置資源文件的文件夾Environment用env表示,C:\Code\XX\下放工程文件的文件夾Projects用pro表示就好。
  • //TODO

目錄總體長度盡量短

原因同上

目錄結(jié)構(gòu)規(guī)劃

一級目錄 C:/Code/

二級目錄 各語言、各IDE的文件夾

如下圖是我當(dāng)前代碼文件和路徑的規(guī)范樣子,可能比較不好的一點(diǎn)是編程語言(A51、PHP、VHDL)和開發(fā)IDE(Altera、Intellij、CLion)放在同一個Code目錄下了,但是總體涉足的語言和工具還不算多,所以根據(jù)上面“目錄總體長度盡量短”原則,不用兩文件夾區(qū)分開,保持這樣就行。


參考

三級目錄 常用通用文件夾

一般小寫開頭

  • env 表示Environment,用于放 開發(fā)環(huán)境相關(guān)配置資源文件
  • pro 表示Projects,用于放 工程文件
    • 在pro下建目錄 <工程名稱_root><工程名稱>,比如C:/Code/Android/pro/robot_root/robot這樣的好處之一是xxx_root下可以再建ref文件夾放參考代碼、建docs放相關(guān)資料等。好處之二是在xxx_root下的工程包xxx可以右鍵壓縮作為本地階段性備份,壓縮完在壓縮包文件名后部用輸入法打timeshijian可快速加入時間截如2017年9月8日 095646,再追加對該備份的備注描述,如下示例
  • lib 表示libraries,用于放 庫文件及庫工程
  • course 放教程,或者推薦放在其他盤里,比較不占C盤空間資源

截圖示例比較好說清楚:

Paste_Image.png

路徑盡量用右斜線 / 不用Windows默認(rèn)的\

因?yàn)?code>/用法更跨平臺通用,且url網(wǎng)址等也是用/。
比如你C:\Code\PHP\xx,可以改手打習(xí)慣為 C:/Code/PHP/xxx,這樣在windows里的地址欄等地方可以用,直接復(fù)制到代碼編輯器里也不用像\必須修改為轉(zhuǎn)義符\\,
所以記得,右斜之~//////////////////有如C代碼注釋//之風(fēng)

電腦分區(qū)建議

Windows下當(dāng)前最好的分區(qū)樣子是不分區(qū)。
如果你只有一個SSD或HDD硬盤。在其它操作系統(tǒng)一般都沒win那樣搞那么多盤的麻煩,文件管理方式不同。如果你電腦系統(tǒng)經(jīng)常崩要重裝那建議分個獨(dú)立C盤D盤就行,反正我筆記本用4年的win7還沒崩過。(聽說國外硬盤大都不分區(qū)因?yàn)樗麄冇谜鎤in很少崩。。。)
如果你電腦是SSD+1T HDD的,那剛好SSD作C盤,HHD作D盤,不要搞出EFG盤,像我這樣,當(dāng)初在win下分太多盤,盤盤間移動耗時,不夠放同類文件時經(jīng)常這盤放一點(diǎn)那盤放一點(diǎn),管理很混亂:(當(dāng)然可以用工具無損合并多個盤但我空間不足還沒空整理)

全盤告急。。

當(dāng)然你用到linux可以再分一個盤來裝。
所以比較建議的是SSD作C盤,HHD作D盤。
而SDD的C盤如C:\Program Files (x86)\用來裝比較吃打開速度、吃運(yùn)算速度、存取頻繁的開發(fā)工具(如AndroidStudio、Eclipse、PS、VS、Matlab、瀏覽器)等軟件,推薦核心常被調(diào)用的庫或工具等裝在固態(tài)c盤,如jre、gnu、ndk,當(dāng)然建議大多開發(fā)工具安裝放c盤互相調(diào)用時比較快。
而D盤如D:\Program Files (x86)用來放平常的軟件,特別是較大型但一般不卡不慢的軟件,如AD、office、音樂視頻閱讀類軟件等。

想到的就先寫這么多吧。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,501評論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,673評論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,610評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,939評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,668評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,004評論 1 329
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,001評論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,173評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,705評論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,426評論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,656評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,139評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,833評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,247評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,580評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,371評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,621評論 2 380

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