1 空格与空行
空格是横向的艺术,空行是竖向的艺术。
- 关键字if,while,for与后面的括号加 空格,例如while(1),单括号内的表达式与括号不加空格。
- 双目运算符两侧加空格,单目运算符不加。例如:i = i+1; ++i;
- 有些终端宽度是80列显示,所以为了兼容,一般列数超过80列,换行。
- 不使用tab缩进, tab用两个空格代替。
- 函数之间,全局变量,头文件引用等逻辑段落之间,加空行。
- swith 与语句块额case default对齐。
- 括号{},单独成行。
- 函数里面如果代码较长,应该分组,并加空行。
2 注释
单行注释用 // ,多行注释用
- 整个源文件的顶部注释,文件名,作者,历史。
- 函数注释,函数的功能,参数,返回值,错误码,写在函数的上面,不留空行。
- 语句组的注释。
- 单行右侧注释。
- 复杂结构,宏定义的注释。
3 标识符命名
- 命名要清晰明了,用完整的单词或者缩写。
- 变量函数和类型用全小写加下划线的方式命名。常量用全大写加下划线命名。
- 全局变量,与全局函数的命名一定要详细。
4 函数
- 函数应该尽量简单,越简单越容易维护。
- 一个函数只做一件事情。
- 函数的内部缩进不要过多,最多不要超过4层。
- 函数的局部变量超过10个也要考虑分割了。
- 函数不要写的太长,超过50行,就考虑要分割了。
- 函数名应该包括动词,一般函数都是标识一个动作。get_name,insert_row.
时间: 2024-12-21 07:08:39