什么是规范呢?意指符合逻辑,客观、真实、全面、完整、准确、及时,达标。明文规定或约定俗成的标准。俗话说:国有国法家有家规,每个行业也都有各自的规章制度,做任何事都有一点的规范。那么对于我们程序员来说当然也有一定的规范。
注释:
在程序员行业,有一句话叫做:代码千万行,注释第一行。这其实也是一种规范,在写代码之前先将注释写好,对于任何一个懂程序的,还是不懂程序的只要认识汉字,就能够理解代码的含义;又或者说几个月前写的代码不用经过千万遍的理逻辑,直接根据注释能够立刻理解代码的含义。这就既方便了自己也方便了大家。
写注释也要注意以下几个方面:
1、不要给不好的名字加注释,一个好的名字比好的注释更重要
2、好代码 > 坏代码 + 好注释
3、在文件/类级别使用全局注释来解释所有部分如何工作
4、一定要给常量加注释
5、团队统一定义标记
- 1)TODO 待处理的问题(关于TODO的用法)
- 2)FIXME 已知有问题的代码
- 3)HACK 不得不采用的粗糙的解决方案
命名:
命名就像我们自己的名字一样,每个人都有一个姓名,我们写的程序中也是一样,在程序中命名也是有一定的规范的,如果胡乱的命名,那么这个程序就乱了,在经过一段时间之后,别说别人,就算自己在看到自己命名的时候恐怕都已经忘记了吧。在程序编码中,有两种常见的命名方式:
Pascal命名法:所有单词的首字母都大写,其他字母小写
Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
这两种方法是在编码程序中常遵守的规则,那么什么时候用Pascal,什么时候用Camel呢?
Pascal | Camel | |
文件名 | √ | |
命名空间 | √ | |
类 | √ | |
接口 | √ | |
枚举 | √ | |
参数 | √ | |
方法 | √ | |
属性 | √ | |
委托 | √ | |
事件 | √ | |
字段 | √ | |
静态字段 | √ |
命名除了遵守这两种命名的规范,还有一些其他的限制:不要将缩写或缩略形式用作标识符名称的组成部分;不要使用计算机领域中未被普遍接受的缩写;在适当的时候,使用众所周知的缩写替换冗长的词组名称;在使用缩写时,对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写等。