C/C++编码规范

来源：互联网发布：acs数据库编辑：程序博客网时间：2024/05/15 09:38

近日阅读《程序设计导引及在线实践》一书，书中有“C/C++编码规范"一节, 阅之，觉得正是自己需要提高的地方，而且觉得这些规范不仅仅对C/C++适用，故摘录于下，望自己谨记于心，付诸实践。

“

一个好的程序，不仅要算法正确,效率高，而且还应该可读性好。所谓程序的可读性，就是程序是否能让人容易读懂。在开发实践中，很多情况下可读性与代码效率同等重要。

如何提高程序的可读性呢？在标识符命名，书写格式，注释三个方面加以注意，再养成一些好的习惯，就能够有效增强程序的可读性。

1.标识符命名注意事项

好的命名方法使标识符易于记忆且使程序的可读性大大提高。

对标识符命名的基本要求是，看到标识符就能想起或猜出它是做什么用的标识符命名应注意以下几点:

(1)标识符号应能提供足够信息以说明其用途。一定不要怕麻烦而懒得起足够长的变量名，少按下几个键省下的时间，和日后自己读该程序或者别人读你的程序时揣摩该变量的作用所花的时间相比，实在微不足道。

(2)为全局变量取长的，描述信息多的名字，为局部变量取稍短的名字。

(3)名字太长时可以适当采用单词的缩写。但要注意缩写方式要一致，要缩写就全都缩写。

(4)注意使用单词的复数形式。

(5)对于返回值为真或假的函数，加"Is"前缀，如：

int IsCanceled();

int isalpha(); //C语言标准库函数

BOOL IsButtonPushed();

2.程序的书写格式

(1)正确地使用缩进：首先，一定要有缩进，否则代码的层次不明显。缩进应为4个空格较好。需要缩进时一律按Tab键，或一律按空格键，不要有时用Tab键缩进，有时用空格键缩进。一般开发环境都能设置一个Tab键相当于多少个空格键，此时就都用Tab键。

(2)行宽与折行：一行不要太长，不能超过显示区域，以免阅读不便。太长则应折行，折行最好发生在运算符前面，不要发生在运算符后面。

(3)'{' , '}'位置不可随意放置。建议将'{'放在一行的右边，而将'}'单独放置一行，这样既不影响可读性，又能节省一行。

但是对于函数体或结构定义的第一个'{'，还是单独一行更为清晰。

(4)变量和运算符之间最好加1个空格。

3.注释的写法

在工程实践中，文件开头，全局变量定义处，以及函数开头都应该有注释。

文件开头的注释模板如下：

/************************************************

**文件名：

**创建人：

**日期：

**修改人：

**日期：

**描述：

**版本：

**-----------------------------------------------

************************************************/

函数开头的注释模板如下：

/***********************************************

**函数名：

**输入：a,b,c

** a---

** b---

** c---

**输出：x---

** x为1，表示...

** x为0，表示...

**功能描述：

**用到的全局变量：

**调用模块：

**作者：

**日期：

**修改：

**日期：

**版本：

**********************************************/

4.一些好的编程习惯

(1)尽量不用立即数，而用#define定义成常量，以便以后修改。例如：

#define MAX_STUDENTS 20

struct SStudent aStudent[MAX_STUDENTS];

比

struct SStudent aStudent[20]

好

(2)使用sizeof(),不直接使用变量所占字节数的数值。

(3)稍复杂的表达式中要积极使用括号，以免优先级理解上的混乱以及二义性。

n = k++ + j; //不好

n = (k++) + j; //好一点

(4)不很容易理解的表达式应分几行写。如：

n = (k++) + j;

应该写成：

n = k + j;

k++;

(5)嵌套的 if else 语句要多使用{}。

(6)单个函数的程序行数最好不要超过100行（两个屏幕高）。

(7)尽量使用标准库函数。

(8)不要随意定义全局变量，尽量使用局部变量。

(9)保持注释和代码完全一致，改了代码别忘改注释。

(10)循环，分支层次最好不要超过5层。

(11)注释可以与语句在同一行，也可以在上行。

(12)一目了然的语句不加注释。

”

附：选择排序算法 C语言实现---

#include<stdio.h>#include<stdlib.h>void selectSort(int *arraypointer , int arraysize);void printArray(int *arraypointer, int arraysize);main(){ int size, i , num , *array; printf("Input the size:"); scanf("%d",&size); //printf("%d/n",size); array = malloc( sizeof( int ) * size ); for(i = 0; i < size; i++){ scanf("%d", &num); array[i] = num; // printf("%d/n",array[i]); } selectSort(array,size); printArray(array,size); free(array);}void selectSort(int *arraypointer , int arraysize){ int i , j , temp; for(i = 0; i < arraysize; i++){ for(j = i + 1; j < arraysize; j++){ if(arraypointer[i] > arraypointer[j]){ temp=arraypointer[j]; arraypointer[j]=arraypointer[i]; arraypointer[i]=temp; } } }}void printArray(int *arraypointer, int arraysize){ int i; for( i = 0; i < arraysize; i++ ){ printf("%d ", arraypointer[i]); }}

上述实现由于交换次数比较多，效率不高，可改为：

#include<stdio.h>#include<stdlib.h>void selectSort(int *arraypointer , int arraysize);void printArray(int *arraypointer, int arraysize);main(){ int size, i , *array; printf("Input the size:"); scanf("%d",&size); //printf("%d/n",size); array = malloc( sizeof( int ) * size ); for(i = 0; i < size; i++){ scanf("%d", &array[i]); // printf("%d/n",array[i]); } selectSort(array,size); printArray(array,size); free(array);}void selectSort(int *arraypointer , int arraysize){ int i , j , temp; for(i = 0; i < arraysize; i++){ int nTmpMin=i; for(j = i + 1; j < arraysize; j++){ if(arraypointer[nTmpMin] > arraypointer[j]) nTmpMin = j; } temp=arraypointer[i]; arraypointer[i]=arraypointer[nTmpMin]; arraypointer[nTmpMin]=temp; }}void printArray(int *arraypointer, int arraysize){ int i; for( i = 0; i < arraysize; i++ ){ printf("%d ", arraypointer[i]); }}