关于代码的编写风格问题
这里主要说以下几项
- 匈牙利命名法
- 关于空格的使用
- 关于注释
1.匈牙利命名法
匈牙利命名法是一种编程时的命名规范。基本原则是:变量名=属性+类型+对象描述
属性部分:
g_ 全局变量
c_ 常量
m_ c++类成员变量
s_ 静态变量
类型部分:
数组 a
指针 p
函数 fn
无效 v
句柄 h
长整型 l
布尔 b
浮点型(有时也指文件) f
双字 dw
字符串 sz
短整型 n
双精度浮点 d
计数 c(通常用cnt)
字符 ch(通常用c)
整型 i(通常用n)
字节 by
字 w
实型 r
无符号 u
描述部分:
描述部分就是根据具体情况对这个变量命名了,一般是这个变量所表示的含义的英文单词的缩写的拼接,其中多个单词时,每个单词或者其缩写的首字母大写,缩写以及单词要能够见名知其意
2.关于空格的使用
-
函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别,关键字之后要留空格。象const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。
-
‘,’之后要留空格,如Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如for (initialization; condition; update)。
-
赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。一元操作符如“!”、“~”、“++”、“–”、“&”(地址运算符)等前后不加空格。象“[ ] ”、“.”、“->”这类操作符前后不加空格。
3.关于注释的位置
注释一般用 /* … */ 或者 // 来进行说明。函数,程序文件,结构体等的注释一般写在相应的实体的上面;变量挑选重要的,难以理解的,意义比较特殊的进行注释,写在后面即可。注释往往是说明两个东西:
- 这个东西是什么
- 这个东西实现什么功能