代码风格规范小结

来源:互联网 发布:unity3d 烘焙场景 编辑:程序博客网 时间:2024/06/05 08:34

现把代码代码风格规范总结如下:

1.代码风格的原则:简明、易读、无二义性

- 缩进:4个空格

- 行宽:< 100 个字符

-复杂表达式中用()清晰表达逻辑优先级

- 所有 { 和 } 都独占一行且成对对齐

- 不要把多条语句和多个变量定义放在同一行

2.命名

类型/类/函数名/变量名等的命名一定要与程序里含义保持一致,以便于阅读理解

- 类型的成员变量通常用m来做前缀

- 一般变量使用 lowerCamel 风格,即第一个单词首字母小写,之后的单词都首字母大写,第一个单词一般用来表示变量类型,如int型变量iCounter

- 类型/类/函数名一般都用 Pascal 风格,即所有单词首字母大写

- 类型/类/变量一般用名词或组合名词,如Member

- 函数名一般用动词或动宾短语,如get/set,RenderPage

3.注释和版权信息

注释也要使用英文,不要使用中文或特殊字符,要保持源代码是ASCII字符格式文件

不要解释程序是如何工作的(How)

要解释程序做什么(What),为什么这么做(Why),以及特别需要注意的地方

每个源文件头部应该有版权、作者、版本、描述等相关信息

0 0
原创粉丝点击