我的编程规范V1.0.doc

宁波幻彩电子工作室 何肖磊我的编程规范V1.0 我的编程规范V1.0一、命名规范：（0）、类型定义：- 定义如下规则 - typedef bitbool;typedef unsigned char int8u;typedef signed char int8s;typedef unsigned int int16u;typedef signed int int16s;typedef unsigned long int32u;typedef signed longint32s;（1）、函数命名格式：对象名_操作名。（ 主语 _动词宾语 ） 说明： （a）主语和宾语如果不是必须的，可以省去。 （b）作为部件、模块或设备时必须加对象名！ - 拼写规则：大写开头- 一般情况：各单词一律由大写字母开头，对象名和操作名之间一律用下划线分割，动词、宾语之间不用下划线分割。正确例子： void Disp(void); /可以省去主语和宾语 void Delay5ms(void);void WaitSignal(void); /可以省去主语 void CPU_Init(void);void Sys_Init(void);/操作名缩写时用大写开头void T0_Enable ( ); /“T0”作为部件,必须加上“T0”这个对象名！ void DS1302_SetTime( ); /“ds1302”作为设备,必须加对象名！ void InforWindow0_DrawGraph( ); void InforWindow0_DrawBox( ); 错误例子： void disp(); /上例为Java风格，本例为C风格 void waitSignal (); /上例为Java风格，本例为C风格 void ds1302_SetTime( ); /上例为Java风格，本例为C风格 void initMcu(); /应为：主语动词，即MCU_Init(); void putcLcd162( ); /应为：主语动词，即LCD162_PutC( ); void DrawInforWindow0Graph(); /应为：主语动词宾语 - 中断函数名格式：中断名_ISR(void) - 一般情况：中断名第一个字母采用大写，这样看起来比较爽，虽然增加了大小写切换时间。 正确例子： void T0_ISR(void); void Timer0_ISR(void);void UART_ISR(void); void CAN_ISR(void); 错误例子： void timer0_isr(); void uart_isr(); （2）、变量命名格式：形容词名词，形容词可省略；- 拼写规则：小写开头。- 一般情况：第一个单词一律用小写字母，其余单词由大写字母开头，且写法为形容词名词，单词间不用下划线分割。 正确例子： int graphWidth; /Java风格 int newValue; /Java风格 错误例子： int GraphWidth; /C风格 int NewValue; /C风格 int graph_width; int new_value; - 特殊情况：如果变量为指针变量：加前缀“ p”，表示“point”；如果名称的特殊写法更鲜为人知，则采用特殊写法； 如果变量为全局变量，根据实际情况，选择性的加前缀“ g”，表示“global”； 如果变量是静态变量，根据实际情况，选择性的加前缀“ s”，表示“static”。正确例子： int8u *pRdDat; int8u i; /int8u j,k,m,n,x,y,z,temp,tmp;int8u gOldPage;/保存页面寄存器；int8u gLcdStatus; int8u gCounter; /可能系统中有多个“counter”，建议加“g” int8u*pStr;/指向字符串的指针int8usTickSum;（3）、常量及宏定义命名格式：大写字母，单词或单词缩写间用下划线分割；- 拼写规则：全部大写- 一般情况：全用大写的字母，用下划线分割单词，且写法为”形容词名词“。 例如： #define STACK_SIZE 100 #define SYS_CLK(20000000UL)#define MSG_TYPE int8u - 特殊情况：如果宏功能带参数用起来跟函数功能一样，可以按照函数名拼写规则进行定义； 正确例子：#define ChangeIntToHex(dec) ( ( (dec)/10) 4 ) + (dec)%10) ) 错误例子：#define changeIntToHex(dec) ( (