C语言的基本编写规范你了解吗

目录

• 基本编写规范
• 一、代码规范化的好处
• 二、规范目的与基本规则
• 1.目的
• 2.基本原则
• 1.空行
• 2.空格
• 3.成对书写(有些编译器会自动补括号)
• 4.缩进(有些编译器会自动缩进)
• 5.对齐(有些编译器会自动对齐)
• 6.代码行
• 7.注释
• 三、其他细节
• 总结

基本编写规范

规范是一种规定，它是一种人为的、约定成俗的，即使不按照那种规定也不会出错，这种规定就叫作规范。虽然我们不按照规范也不会出错，但是那样代码写得就会很乱。如果你养成一种非常不好的写代码的习惯，代码写得乱七八糟，等到将来工作面试的时候，这样的习惯可能会让你失去机会。

一、代码规范化的好处

看着整齐舒服，逻辑清楚，条理清晰。假如你现在用不规范的方式写了一万行代码，现在能看得懂，但等过了三个月你再回头看时就很吃力了，更不要说给别人看了。所以代码要写规范。规范的代码不容易使程序出错，即使出错了查错也会很方便。如果按照不规范的格式输入代码的话，很容易出错。格式虽然不会影响程序的功能，但会影响可读性。程序的格式追求清晰、美观，是程序风格的重要构成元素。

规范的代码

约瑟夫环

#include 
#define N 100
int main()
{
   int n,m=3,s=1;   //n:总人数，m:报数值，s报数人的起始编号 
   scanf("%d",&n);
   int a[N] = {0};  //数组初始化
   int i,j;
   for(i = 0; i < n; i++)	//数组遍历
   {
       a[i] = i+1;   //i是数组的位置量，a[i]是每个人的原始编号（从1开始） 
   }
   i=s-1;   //数组的起点（0） 
   while (n > 1)
   {    
       i = (i+m-1) % n;   //出圈的人在数组中的位置 
       for(j = i+1; j < n; j++)
       {
           a[j-1] = a[j];
       }
       n--;  //出局1人后，总人数-1 
       if(i == n)  //终点后，开始起点（围成一个圈） 
       {
         i = 0;
       }
   }
   printf("%d\n", a[i]);	//输出留下的人的原始编号 
   return 0;
}

不规范的代码

#includeint main(void){int n,u,d,s,t;s=0;t=0;scanf("%d%d%d",&n,&u,&d);if(u>=n) printf("1");else{do{s=s+u;t++;if(s>=n)break;else{s=s-d;t++;}}while(s<=n);printf("%d",t);}}#include
int main(void){int n,u,d,s,t;s=0;
t=0;
scanf("%d%d%d",&n,&u,&d);
if(u>=n) printf("1");
else{
do{s=s+u;t++;
if(s>=n)break;
else
{
s=s-d;
t++;}
}while(s<=n);
printf("%d",t);}
}

二、规范目的与基本规则

1.目的

可移植性、连贯、整洁、易于维护、易于理解、简洁

2.基本原则

1.空行

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存。

规则一：定义变量后要空行。尽可能在定义变量的同时初始化该变量。

规则二：每个函数定义结束之后都要加空行。

规则三：两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是 一个功能，下面几行代码完成的是另一个功能，那么它们中间就要加空行。这样看起来更清晰。

例

2.空格

规则一：关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格，否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(，以突出关键字。

规则二：函数名之后不要留空格，应紧跟左括号(，以与关键字区别。

规则三：(后不打空格; )、,、;这三个前不打空格。

规则四：,之后要留空格。如果;不是一行的结束符号，其后要留空格。

规则五：赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符，如 =、==、！=、+=、－=、*=、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、－、*、/、%、&、|、&&、||、<<、>>、 等双目运算符的前后应当加空格。

注意，%d 中的“%”前后不用加空格。

规则六：单目运算符 !、~、++、－－、－、*、& 等前后不加空格。

规则七：像数组符号[]、结构体成员运算符.、指向结构体成员运算符->，这类操作符前后不加空格。

规则八：对于表达式比较长的 for 语句和 if 语句，为了紧凑起见，可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删，其后面的语句可以根据语句的长度适当地去掉一些空格。例如：
for (i=0; i<10; i++); //for 和分号后面保留空格就可以了，=和<前后的空格可去掉。

3.成对书写(有些编译器会自动补括号)

成对的符号一定要成对书写，如 ()、{}。不要写完左括号然后写内容最后再补右括号，这样很容易漏掉右括号，尤其是写嵌套程序的时候。

4.缩进(有些编译器会自动缩进)

缩进是通过键盘上的 Tab 键实现的，缩进可以使程序更有层次感。原则是：如果地位相等，则不需要缩进；如果属于某一个代码的内部代码就需要缩进。

5.对齐(有些编译器会自动对齐)

规则一：{和}分别都要独占一行。互为一对的{和}要位于同一列，并且与引用它们的语句左对齐。

规则二：{}之内的代码要向内缩进一个 Tab，且同一地位的要左对齐，地位不同的继续缩进。

6.代码行

规则一：一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且便于写注释。

规则二：if、else、for、while、do 等语句自占一行，执行语句不得紧跟其后。此外，非常重要的一点是，不论执行语句有多少行，就算只有一行也要加{}，并且遵循对齐的原则，这样可以防止书写失误。

7.注释

C语言中一行注释一般采用//…，多行注释必须采用/*…*/。注释通常用于重要的代码行或段落提示。在一般情况下，源程序有效注释量必须在 20% 以上。

规则一：注释是对代码的“提示”，而不是文档。注释太多会让人眼花缭乱。

规则二：如果代码本来就是清楚的，则不必加注释。

规则三：边写代码边注释，修改代码的同时要修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除。

规则四：当代码比较长，特别是有多重嵌套的时候，应当在段落的结束处加注释，这样便于阅读。

规则五：每一条宏定义的右边必须要有注释，说明其作用。

例

#include 
int main()
{
	int i = 0;
	int x,y,z;
	int n;
	scanf("%d",&n);
	for(x = 0 ; x <= 100 ; x++)   // 5分
	{
		for(y = 0 ; y <= 100 ; y++)   //2分
		{
			for(z = 0 ; z <= 100 ; z++)  //1分
			{
			    //判断硬币面值相加等于150分时，还要三种硬币相加等于100枚
				if((x*1 + y*2 + z*5 == 150) && x+y+z == 100)
				{
					i++;
					if(z > 0 && z <= n)
					{//判断前N种方案
						printf("%d %d %d",z,y,x);
						if(z < n)
						{//换行输出，同时最后一行输出完，不再换行
							printf("\n");
						}
					}
				}
			}
		}
	}
	return 0;
}

三、其他细节

1.头文件放在代码最前面，头文件include从抽象到具体，次序：C标准库→C++标准库→OS相关→第三方库→工程头文件

2.标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解

常见缩写

总结

本篇文章就到这里了，希望能够给你带来帮助，也希望您能够多多关注脚本之家的更多内容!