C语言代码编码规范

规范,不是规则、规定。不按照规范写代码,程序可能不会出错,但是会很乱、可读性差……
规范和规则、规定是有些不同的。规范通常是一种通用的最佳实践,它描述了一种广泛认可的良好做法,而不是强制性的规定。遵守规范可以使代码更具可读性、可维护性和可扩展性。


不按照规范写代码,程序可能仍然能够运行,但是可能会带来一些问题:

  1. 可读性差:不遵循统一的编码规范会使代码难以阅读和理解。比如,变量命名不一致、缺少必要的空格和缩进等,都会使代码看起来混乱。
  2. 维护困难:当其他人试图理解和修改你的代码时,如果代码不符合规范,会增加他们的工作难度。这可能会导致代码维护成本增加,并可能引发更多的错误和问题。
  3. 性能问题:在某些情况下,不遵循规范可能会影响程序的性能。例如,不恰当地使用资源、没有正确地释放内存等都可能引发性能问题。
  4. 兼容性问题:不遵循标准规范可能会导致程序与其他软件不兼容。例如,不遵循web标准可能会导致网站在某些浏览器中显示不正常。
  5. 安全性问题:不遵循安全编码规范可能会导致安全漏洞。例如,未正确处理用户输入、未对数据库操作进行适当的错误处理等都可能引发安全问题。

因此,尽管不按照规范写代码的程序可能不会立即出错,但长远来看,遵守适当的编码规范是至关重要的。

遵守一个好的规范的代码编写规范是编写程序之前必须要了解的

代码编写规范,方便自己看也方便别人看

#include 

int main(void){
	int a = 1;//注意空格
	
	for (int i = 0; i < 5; i++) {//大括号我习惯这样写
		//……
	}

    for (int i = 0; i < 5; i++) 
    {//这样写也行
		//……
	}
	
	//变量命名:
	//使用小驼峰命名法来命名变量、函数等标识符。
	//小驼峰命名法规定,第一个单词的首字母小写,后续单词的首字母大写。
	int bigPigGod ;

}

规则

基本原则

空行

空行起着分隔程序段落的作用。空行得体将使程序的布局更加清晰。空行不会浪费内存。
规则一:定义变量后要空行。尽可能在定义变量的同时初始化该变量。
规则二:每个函数定义结束之后都要加空行。
规则三:两个相对独立的程序块、变量说明之后必须要加空行。比如上面几行代码完成的是 一个功能,下面几行代码完成的是另一个功能,那么它们中间就要加空行。这样看起来更清晰。

空格

规则一:关键字之后要留空格。像 const、case 等关键字之后至少要留一个空格,否则无法辨析关键字。像 if、for、while 等关键字之后应留一个空格再跟左括号(,以突出关键字。
规则二:函数名之后不要留空格,应紧跟左括号(,以与关键字区别。
规则三:(后不打空格; )、,、;这三个前不打空格。
规则四:,之后要留空格。如果;不是一行的结束符号,其后要留空格。
规则五:赋值运算符、关系运算符、算术运算符、逻辑运算符、位运算符,如 =、==、!=、+=、-=、=、/=、%=、>>=、<<=、&=、=、|=、>、<=、>、>=、+、-、、/、%、&、|、&&、||、<<、>>、 等双目运算符的前后应当加空格。

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

规则六:单目运算符 !、~、++、--、-、*、& 等前后不加空格。
规则七:像数组符号[]、结构体成员运算符.、指向结构体成员运算符->,这类操作符前后不加空格。
规则八:对于表达式比较长的 for 语句和 if 语句,为了紧凑起见,可以适当地去掉一些空格。但 for 和 if 后面紧跟的空格不可以删,其后面的语句可以根据语句的长度适当地去掉一些空格。例如:for (i=0; i<10; i++); for 和分号后面保留空格就可以了,=和<前后的空格可去掉。

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

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

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

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

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

规则一:{和}分别都要独占一行。互为一对的{和}要位于同一列,并且与引用它们的语句左对齐。
规则二:{}之内的代码要向内缩进一个 Tab,且同一地位的要左对齐,地位不同的继续缩进。

代码行

规则一:一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且便于写注释。
规则二:if、else、for、while、do 等语句自占一行,执行语句不得紧跟其后。此外,非常重要的一点是,不论执行语句有多少行,就算只有一行也要加{},并且遵循对齐的原则,这样可以防止书写失误。

注释

C语言中一行注释一般采用//…,多行注释必须采用//。注释通常用于重要的代码行或段落提示。在一般情况下,源程序有效注释量必须在 20% 以上。
规则一:注释是对代码的“提示”,而不是文档。注释太多会让人眼花缭乱。
规则二:如果代码本来就是清楚的,则不必加注释。
规则三:边写代码边注释,修改代码的同时要修改相应的注释,以保证注释与代码的一致性,不再有用的注释要删除。
规则四:当代码比较长,特别是有多重嵌套的时候,应当在段落的结束处加注释,这样便于阅读。
规则五:每一条宏定义的右边必须要有注释,说明其作用。

你可能感兴趣的:(C语言学习笔记(入门到入神),c语言,开发语言)