编码规范（函数、过程篇）

//摘抄自华为软件编写规范
1、对所调用函数的错误返回码要仔细、全面地处理
2、防止将函数的参数作为工作变量
说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。
示例：下函数的实现不太好。

void sum_data( unsigned int num, int *data, int *sum ) 
{ 
     unsigned int count; 
     *sum = 0; 
     for (count = 0; count < num; count++) 
     { 
         *sum   += data[count]; // sum 成了工作变量，不太好。 
     } 
} 

若改为如下，则更好些。

void sum_data( unsigned int num, int *data, int *sum ) 
{ 
     unsigned int count ; 
     int sum_temp; 
     sum_temp = 0; 
     for (count = 0; count < num; count ++) 
     { 
         sum_temp   += data[count];  
     } 
     *sum = sum_temp; 
} 

3、函数的规模尽量限制在 200 行以内
说明：不包括注释和空格行。
4、一个函数仅完成一件功能
5、为简单功能编写函数
说明：虽然为仅用一两行就可完成的功能去编函数好象没有必要，但用函数可使功能明确化，增加程序可
读性，亦可方便维护、测试。
示例：如下语句的功能不很明显。

value = ( a > b ) ? a : b ; 
改为如下就很清晰了。  
int max (int a, int b) 
{ 
     return ((a > b) ? a : b); 
} 
value = max (a, b); 
或改为如下。  
#define MAX (a, b) (((a) > (b)) ? (a) : (b)) 
value = MAX (a, b); 

6、不要设计多用途面面俱到的函数
说明：多功能集于一身的函数，很可能使函数的理解、测试、维护等变得困难
7、函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出
8、尽量不要编写依赖于其他函数内部实现的函数
9、避免设计多参数函数，不使用的参数从接口中去掉
说明：目的减少函数间接口的复杂度。
10、非调度函数应减少或防止控制参数，尽量只使用数据参数
说明：本建议目的是防止函数间的控制耦合。调度函数是指根据输入的消息类型或控制命令，来启动相应的功能实体（即函数或过程），而本身并不完成具体功能。控制参数是指改变函数功能行为的参数，即函数要根据此参数来决定具体怎样工作。非调度函数的控制参数增加了函数间的控制耦合，很可能使函数间的耦合度增大，并使函数的功能不唯一。
示例：如下函数构造不太合理。

int add_sub( int a, int b, unsigned char add_sub_flg ) 
{ 
     if (add_sub_flg == INTEGER_ADD) 
     { 
         return (a + b); 
     } 
     else 
     { 
         return (a   b); 
     } 
} 
不如分为如下两个函数清晰。  
int add( int a, int b ) 
{ 
     return (a + b); 
} 
int sub( int a, int b )  
{ 
     return (a   b); 
} 

11、检查函数所有参数输入的有效性
12、检查函数所有非参数输入的有效性，如数据文件、公共变量等
说明：函数的输入主要有两种：一种是参数输入；另一种是全局变量、数据文件的输入，即非参数输入。
函数在使用输入之前，应进行必要的检查。
13、函数名应准确描述函数的功能，使用动宾词组为执行某操作的函数命名。如果是 OOP 方法，可以只有动词（名词是对象本身），避免使用无意义或含义不清的动词为函数命名
说明：避免用含义不清的动词如 process、handle 等为函数命名，因为这些动词并没有说明要具体做什么。
14、函数的返回值要清楚、明了，让使用者不容易忽视错误情况
说明：函数的每种出错返回值的意义要清晰、明了、准确，防止使用者误用、理解错误或忽视错误返回码。
15、除非必要，最好不要把与函数返回值类型不同的变量，以编译系统默认的转换方式或强制的转换方式作为返回值返回
16、在调用函数填写参数时，应尽量减少没有必要的默认数据类型转换或强制数据类型转换
说明：因为数据类型转换或多或少存在危险。
17、防止把没有关联的语句放到一个函数中
说明：防止函数或过程内出现随机内聚。随机内聚是指将没有关联或关联很弱的语句放到同一个函数或过程中。随机内聚给函数或过程的维护、测试及以后的升级等造成了不便，同时也使函数或过程的功能不明确。使用随机内聚函数，常常容易出现在一种应用场合需要改进此函数，而另一种应用场合又不允许这种改进，从而陷入困境。
在编程时，经常遇到在不同函数中使用相同的代码，许多开发人员都愿把这些代码提出来，并构成一个新
函数。若这些代码关联较大并且是完成一个功能的，那么这种构造是合理的，否则这种构造将产生随机内聚的函数。
示例：如下函数就是一种随机内聚。

void Init_Var( void ) 
{ 
     Rect.length = 0; 
     Rect.width = 0; /*  初始化矩形的长与宽  */ 
     Point.x = 10; 
     Point.y = 10;    /*  初始化“点”的坐标  */ 
} 
矩形的长、宽与点的坐标基本没有任何关系，故以上函数是随机内聚。  
应如下分为两个函数：  
void Init_Rect( void ) 
{ 
     Rect.length = 0; 
     Rect.width = 0; /*  初始化矩形的长与宽  */ 
} 
void Init_Point( void ) 
{ 
     Point.x = 10; 
     Point.y = 10;    /*  初始化“点”的坐标  */ 
} 

18、如果多段代码重复做同一件事情，那么在函数的划分上可能存在问题
说明：若此段代码各语句之间有实质性关联并且是完成同一件功能的，那么可考虑把此段代码构造成一个新的函数。
功能不明确较小的函数，特别是仅有一个上级函数调用它时，应考虑把它合并到上级函数中，而不必单独存在
说明：模块中函数划分的过多，一般会使函数间的接口变得复杂。所以过小的函数，特别是扇入很低的或功能不明确的函数，不值得单独存在。
19、设计高扇入、合理扇出（小于 7 ）的函数
说明：扇出是指一个函数直接调用（控制）其它函数的数目，而扇入是指有多少上级函数调用它。
扇出过大，表明函数过分复杂，需要控制和协调过多的下级函数；而扇出过小，如总是 1，表明函数的调用层次可能过多，这样不利程序阅读和函数结构的分析，并且程序运行时会对系统资源如堆栈空间等造成压力。函数较合理的扇出（调度函数除外）通常是 3-5。扇出太大，一般是由于缺乏中间层次，可适当增加中间层次的函数。扇出太小，可把下级函数进一步分解多个函数，或合并到上级函数中。当然分解或合并函数时，不能改变要实现的功能，也不能违背函数间的独立性。
扇入越大，表明使用此函数的上级函数越多，这样的函数使用效率高，但不能违背函数间的独立性而单纯地追求高扇入。公共模块中的函数及底层函数应该有较高的扇入。
较良好的软件结构通常是顶层函数的扇出较高，中层函数的扇出较少，而底层函数则扇入到公共模块中。
20、 减少函数本身或函数间的递归调用
说明：递归调用特别是函数间的递归调用（如 A->B->C->A），影响程序的可理解性；递归调用一般都占用较多的系统资源（如栈空间）；递归调用对程序的测试有一定影响。故除非为某些算法或功能的实现方便，应减少没必要的递归调用。
21、当一个过程（函数）中对较长变量（一般是结构的成员）有较多引用时，可以用一个意义相当的宏代替
说明：这样可以增加编程效率和程序的可读性。

在某过程中较多引用 TheReceiveBuffer[FirstSocket].byDataPtr， 
则可以通过以下宏定义来代替：  
# define pSOCKDATA TheReceiveBuffer[FirstScoket].byDataPtr