怎么把c代码写规范

c/c++源代码书写规范 1. 在.h/.cpp的开头应有一段格式统一的说明，内容包括： a. 文件名 (filename)； b. 创建人 (creator)； c. 文件创建时间 (date)； d. 简短说明文件功能、用途 (comment)。 例： ////////////////////////////////////////// // // filename: getversion.h // creator: liu haifeng // date: 2002-10-28 // comment: get file version information // ////////////////////////////////////////// 2.对于主要功能函数应有注释说明。内容包括：功能、入口/出口参数，必要时还可有备注或补充说明，对于函数中的主要功能代码，也应有注释说明。注释以英文为主。 例： ////////////////////////////////////////// // //remarks: // check file whether exist // //parameters: // lpctstr lpszpathname : input full path name // //return values: // int : non-zero means success // zero means failure // ////////////////////////////////////////// 3. 每列代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。 例：handle ksopenfile(const char cszfilename[], int nmode); 或者： bool ksreadfile( handle hfile, void *pvbuffer, int nreadsize, int *pnreadsize ); 4. 循环、分支代码，判断条件与执行代码不得在同一行上。 例：正确： if (n == -2) n = 1; else n = 2; 不得写做： if (n == -2) n = 1; else n = 2; 5. 指针的定义，* 号既可以紧接类型，也可以在变量名之前。 例：可写做：int* pnsize; 也可写做：int *pnsize; 但不得写做：int * pnsize; 6. 在类的成员函数内调用非成员函数时，在非成员函数名前必须加上"::"。 例：::sleep(2000); 7. 函数入口参数有缺省值时，应注释说明。 例: bool kssavetofile( const char cszfilename[], bool bcanreplace ); 或者： bool kssavetofile( const char cszfilename[], bool bcanreplace // = true ); 8. else if 必须写在一行。 9. 与‘{’、‘}’有关的各项规定： 9.1‘{’、‘}’应独占一行。在该行内可有注释。 例：正确： for (i = 0; i < cbline; i++) { // ..... printf("line %d:", i); printf("%s\n", pfilelines); } 不得写做： for (i = 0; i < cb; i++) { printf("line %d:", i); printf("%s\n", pfilelines); } 9.2‘{’必须另起一行，‘{’之后的代码必须缩进一个tab。‘{’与‘}’必须在同一列上。 例：正确： if (i > 0) { m = 1; n++; } 不得写做： if (i > 0) { m = 1; n++; } 例外： if (i == 0) { assert(false); return; } 9.3 在循环、分支之后若只有一行代码，虽然可省略‘{’、‘}’，但不推荐这么做。若省略后可能引起歧义，则必须加上‘{’、‘}’。 例：正确： if (n == -2) n = 1; else n = 2; 或者： if (n == -2) { n = 1; } else if (n != ntemp) { n = 2; } else { n = 3; } 不得写做： if (n == -2) n = 1; else if (n != ntemp) n = 2; else n = 3; 不推荐： if (i < 1) { n = 1; } else { if (i == 1) { n = 2; } else { if (i > 1) { n = 3; } } } 10. 与空格有关的各项规定。 10.1 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在‘->’、‘::’、‘.’、‘[’、‘]’等运算符前后，及‘&’（取地址）、‘*’（取值）等运算符之后不得有空格。 例：正确： int n = 0, ntemp; for (int i = nminline; i <= nmaxline; i++) 不得写做： int n=0, ntemp; for ( int i=nminline; i<=nmaxline; i++ ) 10.2 for、while、if 等关键词之后应有1个空格，再接‘(’，之后无空格；在结尾的‘)’前不得有空格。 例：正确： if (-2 == n) 不得写做： if(-2 == n) 或 if ( -2 == n ) 等等。 10.3 调用函数、宏时，‘(’、‘)’前后不得有空格。 例：正确： printf("%d\n", nindex); 不得写做： printf ("%d\n", nindex); printf( "%d\n", nindex ); 等等。 10.4 类型强制转换时，‘(’‘)’前后不得有空格 例：可写做： (ksfile*)pfile; 也可写做： (ksfile *)pfile 不得写做： ( ksfile* )pfile ( ksfile * ) pfile 11. 与缩进有关的各项规定 11.1 缩进以 tab 为单位。1 个 tab 为 4 个空格 11.2 下列情况，代码缩进一个 tab: 1. 函数体相对函数名及'{'、'}'。 例： int power(int x) { return (x * x); } 2. if、else、for、while、do 等之后的代码。 3. 一行之内写不下，折行之后的代码，应在合理的位置进行折行。若有 + - * / 等运算符，则运算符应在上一行末尾，而不应在下一行的行首。 11.3 下列情况，不必缩进：switch 之后的 case、default。 例： switch (nid) { case id_play: ...... break; case id_stop: ...... break; default: ...... break; 12.对于涉及到系统的功能调用，要求使用系统提供的宏，不得直接使用具体的数值。 例： char szsystempath[max_path] = {0}; 正确 char szsystempath[260] = {0}; 错误 13.关于函数编写的规定 13.1 除了非常简单的函数或者没有必要，函数需要有返回值，并且推荐 返回值的类型为int，成功时为 true，失败时为false。不推荐直接使用1和0来表示。 13.2 在函数内部变量定义全部放在函数的开始处，不能在代码中间出现 变量定义。变量定义需要初始化值，一般是0、false、null等。 13.3 程序员自行编写的函数不推荐使用dword等指明字节长度的变量 类型，推荐使用unsigned long等变量类型。对于ulong等vc系统定义的变量类型，推荐使用unsigned long 来代替。如果调用系统api，在msdn中已经指明了是dword等类型，则可以使用。 13.4 推荐使用int nresult作为函数自身的返回值变量，int nretcode、bool bretcode作为调用其他函数的返回值变量。 13.5 推荐使用goto语句来统一函数出口，goto语句一般只能跳转到一个函数出口，最多只能有两个，出口标识必须命名为exit0和exit1。在出口处必须显式检查曾经申请过的系统资源（如内存），并且进行释放。 13.6 如果编写dll，除非特殊情况，导出函数的调用类型必须是__stdcall，便于多模块协同工作。 附录： 1．函数编写示范 ///////////////////////////////////////////////////////////////////// // // remarks: // get file version information // // parameters: // [in] const char cszpathname : input file path name // [out] pversion_info *pversioninfo : file version information // // return values: // int : non-zero means success, zero means failure // ///////////////////////////////////////////////////////////////////// int getfileversion(const char cszpathname, pversion_info *pversioninfo) { int nresult = false; int nretcode = false; char szsystempath[max_path] = {0}; nretcode = isfileexist(cszpathname); if (!nretcode) goto exit0; //others code here nresult = true; exit0: return nresult; }以前你的习惯可能是我定义一个函数，通过传递参数去实现这个函数的功能。面向对象编程要体现三个特点“封装、继承、多态”；比如你写一个飞这个函数，你需要在这里传递参数飞机。换个角度，你定义一个类是飞机，那这个飞机在封装的过程就有飞。降落等这功能(函数)。你想要用飞这个功能(函数)的时候，你只需调用飞机这个类“飞”这个成员函数。