C语言编程风格

实习了一段时间,对于C语言的书写风格,做一个小总结,为以后写代码做个标杆。


1变量定义

在定义变量时,前缀使用变量的类型,之后使用表现变量用途的英文单词或单词缩写,且每个单词或缩写的首字母大写,各种前缀缩写如下:

无符号变量使用 u8u16u32;例:unsigned char u8Temp

有符号变量使用 s8s16s32;例:char s8Temp

浮点数变量使用 f32d64;例:float f32Temp

结构体变量使用 st;例:struct Temp stTemp

字符串变量使用 s;例:char sTemp

数组变量使用   a;例:unsigned char aTemp[10]

指针变量使用   p;例:unsigned char  *pTemp

枚举变量使用   e;例:enum Temp    eTemp

宏定义

对于宏定义使用大写+下划线的方式。

程序排版

一行程序的开始使用tab键进行对齐,一行的中间使用空格键进行对齐。

这样防止不同的编辑工具打开时,造成代码混乱。

注释的书写

这里注释分为函数头注释,程序中代码注释,

函数头注释使用如下形式

/*

*Name:

*Description:

*Created:

*Author:

*/

这四项必选,其他的如函数的传入传出参数,视函数的需要适当增加。

测试代码

在编程的同时,需要注意添加适当的测试代码,这样可以减轻以后测试代码时的工作量。

你可能感兴趣的:(C语言)