C语言编程规范Word格式文档下载.docx

1、和：if （x = y） .else if （x y） .注意，右括号所在的行不应当有其它东西，除非跟随着一个条件判断。也就是do-while语句中的“while”，象这样：do body of do-loop while （condition）;说明：代码离不开缩进，缩进背后的思想是：清楚地定义一个控制块从哪里开始，到哪里结束。尤其是在你连续不断的盯了20个小时的屏幕后，如果你有大尺寸的缩进。你将更容易发现缩进的好处。关于缩进主要有两个争论，一个是该用空格（Space）还是用制表符（Tab），另外一个是该用4格缩进还是8格缩进甚至都不是。建议总是使用Tab缩进，因为几乎所有的代码（不仅仅是C

2、代码）都在使用Tab缩进。现在，有些人说8个字符大小的缩进导致代码太偏右了，并且在一个80字符宽的终端屏幕上看着很不舒服。对这个问题的回答是：如果你有超过3个级别的缩进，你就有点犯糊涂了，应当修改你的程序。简而言之，8个字符的缩进使程序更易读，而且当你把功能隐藏的太深时，多层次的缩进还会对此很直观的给出警告。要留心这种警告信息。例外：对于由开发工具自动生成的代码可以有不一致。1.2 及时折行较长的语句（80 字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进（至少1个TAB位置），使排版整齐，语句可读。report_or_not_fla

3、g = （taskno MAX_ACT_TASK_NUMBER） & （n7stat_stat_item_valid （stat_item） （act_task_tabletaskno.result_data != 0）;循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分新行，操作符放在新行之首。if （taskno max_act_task_number） & （n7stat_stat_item_valid （stat_item） . / program codefor （i = 0, j = 0; （i BufferKeywordword_ind

4、ex.word_length） & （j ），后不应加空格。采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧（即左括号后面和右括号前面）不需要加空格，多重括号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。（1）逗号、分号只在后面加空格。int a, b, c;（2）比较操作符, 赋值操作符=、 +=，算术操作符+、%，逻辑操作符，位域操作符= MAX_TIME

5、_VALUE） a = b + c;a *= 2;a = b 2;（3）!+-（地址运算符）等单目操作符前后不加空格。*p = a; / 内容操作*与内容之间flag = !isEmpty; / 非操作p = &mem; / 地址操作 与内容之间i+; / ,（4）-.前后不加空格。p-id = pid;指针前后不加空格（5） if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if （a = b & c d）1.7 对变量的定义，尽量位于函数的开始位置（1）应避免分散定义变量。（2）同一行内不要定义过多变量。 （3）同一类的变量在同一行内定义，或者在

6、相邻行定义。（4）数组、指针等复杂类型的定义放在定义区的最后。（5）变量定义区不做较复杂的变量赋值。1.8 程序各部分的放置顺序在较小的项目中，按如下顺序组织安排程序各部分：（1）#include 。（2）#include 用户自定义的文件。（3）#define 宏定义。（4）全局变量定义。（5）函数原型声明。（6）main函数定义。（7）用户自定义函数。以上各部分之间、用户自定义的函数之间应加空行。注意，函数原型声明统一集中放在main函数之前，不放在某个函数内部。2 注释2.1 注释的原则和目的注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确

7、、易懂、简洁。通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的清晰准确的函数、变量等的命名，可增加代码可读性，并减少不必要的注释过量的注释则是有害的。注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。 示例：如下注释意义不大。/* if receive_flag is TRUE */if （receive_flag）而如下的注释则给出了额外有用的信息。/* if mtp receive a message from links */2.2 函数头部应进行注释函数头部应进行注释，列出：函数的目的/ 功

8、能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例1：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Function: / 函数名称 Description: / 函数功能、性能等的描述 Calls: / 被本函数调用的函数清单 Called By: / 调用本函数的函数清单 Input: / 输入参数说明，包括每个参数的作 / 用、取值说明及参数间关系。 Output: / 对输出参数的说明。 Return: / 函数返回值的说明 Others: / 其它说明*/对于某些函数，其部分参数为传入值，而部分参数为传出值，所以对参数要详细说明该参数是

9、入口参数，还是出口参数，对于某些意义不明确的参数还要做详细说明（例如：以角度作为参数时，要说明该角度参数是以弧度（PI）,还是以度为单位）,对既是入口又是出口的变量应该在入口和出口处同时标明。等等。在注释中详细注明函数的适当调用方法，对于返回值的处理方法等。在注释中要强调调用时的危险方面，可能出错的地方。2.3 进行注释时的注意事项（1）建议边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。（2）注释的内容要清楚、明了，含义准确，防止注释二义性。错误的注释不但无益反而有害。（3）避免在注释中使用缩写，特别是非常用缩写。在使用缩写时或之前，应对缩写进行必

10、要的说明。（4）注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面。除非必要，不应在代码或表达中间插入注释，否则容易使代码可理解性变差。如下例子不符合规范。例1：/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;例2：（5）对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方

11、相邻位置或右方。/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */（6）数据结构声明（ 包括数组、结构、类、枚举等） ，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。可按如下形式说明枚举/数据/联合结构。/* sccp interface with sccp user primitive mess

12、age name */enum SCCP_USER_PRIMITIVE N_UNITDATA_IND, /* sccp notify sccp user unit data come */ N_NOTICE_IND, /* sccp notify user the No.7 network can not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp users unit data transmission request*/;（7）全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等

13、的说明。/* The ErrorCode when SCCP translate */* Global Title failure, as follows */ / 变量作用、含义/* 0 SUCCESS 1 GT Table error */* 2 GT error Others no use */ / 变量取值范围/* only function SCCPTranslate（） in */* this modual can modify it, and other */* module can visit it through call */* the function GetGTTran

14、sErrorCode（） */ / 使用方法BYTE g_GTTranErrorCode;（8）注释与所描述内容进行同样的缩排，让程序排版整齐，并方便注释的阅读与理解。如下例子，排版不整齐，阅读稍感不方便。void example_fun（ void ）/* code one comments */ CodeBlock One /* code two comments */ CodeBlock Two应改为如下布局。 /* code one comments */ /* code two comments */（9）将注释与其上面的代码用空行隔开。如下例子，显得代码过于紧凑。program c

15、ode one/* code two comments */program code two（10）对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。（11）对于switch 语句下的case 语句，如果因为特殊情况需要处理完一个case 后进入下一个case 处理（即上一个case后无break），必须在该case 语句处理完、下一个case 语句前加上明确的注释，以清楚表达程序编写者的意图，有效防止无故遗漏break语句（可避免后期维护人员对此感到迷惑：原程序员是遗漏

16、了break语句还是本来就不应该有）。case CMD_DOWN: ProcessDown（）; break;case CMD_FWD: ProcessFwd（）; if （.） break; else ProcessCFW_B（）; / now jump into case CMD_Acase CMD_A: ProcessA（）;.（12）在程序块的结束行右方加注释标记，以表明某程序块的结束。当代码段较长，特别是多重嵌套时，这样做可以使代码更清晰，更便于阅读。参见如下例子。if （.） program code while （index MAX_INDEX） program code /* end of while （index tmp、flag-flg、statistic-stat、increment-inc、message-msg等缩写能够被大家基本认可。（2）命名中若使用特殊约定或缩写，则要有注释说明。应该在源文件的开始之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注释说明。（3）自己特有的命名风格，要自始至终保持一致，不可来回变化。个人的命名风格，在符合所在项目组或产品组的命名规则的前提下，才可使用