代码的文件和路径命名规范和目录结构规划

简介

环境一搭好一般都不大好改动路径文件夹和文件名称,所以规范些比较好。

规则经验

文件、文件夹命名法

  • 用字母或下划线_开头的驼峰命名法,比较特有的名称用大驼峰命名法(A51、PHP、VHDL、Altera、Intellij、CLion),通用和常见的名称用小驼峰命名法(env、pro)。不要用中文或特殊字符,如“ ” & - 空格等(空格在指令或代码编辑器里经常要加转义符\ 麻烦),因为我们最好要做到Windows Linux Mac等跨平台通用(比如有种情况,zip文件在跨平台解压时有些文件名不符系统规则导致无法解压),且大多有些旧硬件开发工具不支持中文路径,及如AndroidStudio中资源文件命名要求等原因,所以名称最好最好都 只含英文字母、下划线、数字,并只用字母或下划线开头。另外,c++带有特殊字符+,偶尔必要时可用cppcxx命名代替。
  • 文件文件夹名称尽量短,原因之一:有些开发工具对路径长度要求128B内甚至更短,之二:比较容易看。
    例如C:\Code\XX\下放开发环境相关配置资源文件的文件夹Environment用env表示,C:\Code\XX\下放工程文件的文件夹Projects用pro表示就好。
  • //TODO

目录总体长度尽量短

原因同上

目录结构规划

一级目录 C:/Code/

二级目录 各语言、各IDE的文件夹

如下图是我当前代码文件和路径的规范样子,可能比较不好的一点是编程语言(A51、PHP、VHDL)和开发IDE(Altera、Intellij、CLion)放在同一个Code目录下了,但是总体涉足的语言和工具还不算多,所以根据上面“目录总体长度尽量短”原则,不用两文件夹区分开,保持这样就行。


参考

三级目录 常用通用文件夹

一般小写开头

  • env 表示Environment,用于放 开发环境相关配置资源文件
  • pro 表示Projects,用于放 工程文件
    • 在pro下建目录 <工程名称_root><工程名称>,比如C:/Code/Android/pro/robot_root/robot这样的好处之一是xxx_root下可以再建ref文件夹放参考代码、建docs放相关资料等。好处之二是在xxx_root下的工程包xxx可以右键压缩作为本地阶段性备份,压缩完在压缩包文件名后部用输入法打timeshijian可快速加入时间截如2017年9月8日 095646,再追加对该备份的备注描述,如下示例
  • lib 表示libraries,用于放 库文件及库工程
  • course 放教程,或者推荐放在其他盘里,比较不占C盘空间资源

截图示例比较好说清楚:

Paste_Image.png

路径尽量用右斜线 / 不用Windows默认的\

因为/用法更跨平台通用,且url网址等也是用/
比如你C:\Code\PHP\xx,可以改手打习惯为 C:/Code/PHP/xxx,这样在windows里的地址栏等地方可以用,直接复制到代码编辑器里也不用像\必须修改为转义符\\
所以记得,右斜之~//////////////////有如C代码注释//之风

电脑分区建议

Windows下当前最好的分区样子是不分区。
如果你只有一个SSD或HDD硬盘。在其它操作系统一般都没win那样搞那么多盘的麻烦,文件管理方式不同。如果你电脑系统经常崩要重装那建议分个独立C盘D盘就行,反正我笔记本用4年的win7还没崩过。(听说国外硬盘大都不分区因为他们用正版win很少崩。。。)
如果你电脑是SSD+1T HDD的,那刚好SSD作C盘,HHD作D盘,不要搞出EFG盘,像我这样,当初在win下分太多盘,盘盘间移动耗时,不够放同类文件时经常这盘放一点那盘放一点,管理很混乱:(当然可以用工具无损合并多个盘但我空间不足还没空整理)

全盘告急。。

当然你用到linux可以再分一个盘来装。
所以比较建议的是SSD作C盘,HHD作D盘。
而SDD的C盘如C:\Program Files (x86)\用来装比较吃打开速度、吃运算速度、存取频繁的开发工具(如AndroidStudio、Eclipse、PS、VS、Matlab、浏览器)等软件,推荐核心常被调用的库或工具等装在固态c盘,如jre、gnu、ndk,当然建议大多开发工具安装放c盘互相调用时比较快。
而D盘如D:\Program Files (x86)用来放平常的软件,特别是较大型但一般不卡不慢的软件,如AD、office、音乐视频阅读类软件等。

想到的就先写这么多吧。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容