修正开发中的规范
前言:参阅Google代码规范会比此文章收获更多不同的想象。文章是个人阅历积累的。
为什么要修正开发中的规范,修正开发规范利于代码可读性和维护性。好的代码规范有助于开发和长期维护,团队协作中有利于各个模块和各个功能之间互相理解。
一个变量为i,要是放在一大推代码中的某个局外会很模糊,要是放在for里,只需要找每个for就能知道在哪。
一个类命名为File,我们将很清楚他基础操作是读写。
文件名命名规则
文件命名非常重要,在一个微服务或者框架开发中有规则的命名文件名能更好帮助自己和团队找到文件,并且从文件名得知这个文件的功能和用处。
好的文件名命名规则会让人觉得就像见到属于自己的初恋,让人念念不忘。
模块化命名法
如果一个程序或框架他是由大大小小模块集成,可以称之为模块化。
模块化每个功能是单独互不影响的,也不因为你这个模块影响扩散到整个程序。
文件命名规则
有些人喜欢乱命名文件夹,这是非常影响文件夹的观感,让人觉得这个文件夹就是很糟糕、不理解、好奇。
一个好的观感文件夹名称,可能会得到一眼关注、马上回忆到这个文件夹里所包含的文件内容。
心理研究:名字对他人的影响,进而影响到名字主人
1 | # 通常认为 |
子目录命名
1 |
骆驼命名法
这是最常说的命名规则,特别对于一个团队项目是最为突出的。此命名法分小驼和大驼峰法。
小驼峰法
开头的单词小写,第二单词之后每个单词的首字母大写。
常用于变量、常量
大驼峰法
每个单词首字母大写。
常用于 类、属性、命名空间、包
宏(延展)
每个字母大写
列如:
1 | # 小驼峰法 |
骆驼峰法一些见解
(未完继续…)