c代码风格规范.
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
代码风格规范
0. 说明
请先阅读一篇搞笑文章——《说一说编程恶习》
本规范尚在完善中,随时更新。
代码风格以增强程序可读性和可维护性为目标,并非金科玉律。在满足可读性和可维护性的前提下,可以适当灵活。
代码风格的细节比较繁杂,这里不会一一给出,请多看示例代码来体会其精妙之处。
1. 注释
1. 程序中必须有清晰的注释;
2. 程序头部要有程序整体说明信息;
3. 每个函数(main除外)都要有注释说明该函数的功能,及其参数和返回
值的意义;
4. 每个变量都要有注释说明其用途(for 循环中的下标除外;
5. 代码中要有适当的注释说明代码段的功能。
2. 缩进
1. 缩进的宽度为4个字符,鼓励用空格缩进, tab亦可(但尽量避免两者混
用;
2. 凡函数、if、while、for、do-while、switch等都要使用缩进,具体形式
参考示例代码。
3. 标识符命名
1. 凡标识符的命名要尽量能直观反映该标识符的功能(如做到这一点,可免
去注释说明);
2. 标识符用英文命名,不可用汉语拼音;
3. 变量命名采用“variable_name”的形式;
4. 函数命名采用“FunctionName”的形式;
5. 宏、常量、枚举的命名采用“MACRO_NAME”的形式。
4. 空行及空格
1. 以增强可读性为目标,适当使用空行和空格;
2. 不可出现连续的两个及两个以上的空行;
3. 代码功能段之间用空行分隔;
4. 不在行尾的每个逗号和分号后要有一个空格;
5. 一般每个运算符前后都要有一个空格;
6. if, while, for, do, switch 和判断条件之间要有一个空格。
5. 其它
1. 左大括号“{”后不可出现代码;
2. 右大括号“}”前不可出现代码;
3. 每行只能写一条代码,且该行代码总长不可超过80个字符;
4. 常数应定义为宏、枚举或常量;
5. ……