写好函数的几个要点

        在软件设计中，扇入和扇出的概念是指应用程序模块之间的层次调用情况。 
        按照结构化设计方法，一个应用程序是由多个功能相对独立的模块所组成。 
        扇入：是指直接调用该模块的上级模块的个数。扇入大表示模块的复用程序高。
        扇出：是指该模块直接调用的下级模块的个数。扇出大表示模块的复杂度高，需要控制和协调过多的下级模块；但扇出过小（例如总是1）也不好。扇出过大一般是因为缺乏中间层次，应该适当增加中间层次的模块。扇出太小时可以把下级模块进一步分解成若干个子功能模块，或者合并到它的上级模块中去。 
        设计良好的软件结构，通常顶层扇出比较大，中间扇出小，底层模块则有大扇入。

 

        设计高扇入、合理扇出（小于7 ）的函数 
        说明：扇出是指一个函数直接调用（控制）其它函数的数目，而扇入是指有多少上级函数调用它。 
        扇出过大，表明函数过分复杂，需要控制和协调过多的下级函数；而扇出过小，如总是1，表明函数的调用层次可能过多，这样不利程序阅读和函数结构的分析，并且程序运行时会对系统资源如堆栈空间等造成压力。函数较合理的扇出（调度函数除外）通常是3-5。扇出太大，一般是由于缺乏中间层次，可适当增加中间层次的函数。扇出太小，可把下级函数进一步分解多个函数，或合并到上级函数中。当然分解或合并函数时，不能改变要实现的功能，也不能违背函数间的独立性。扇入越大，表明使用此函数的上级函数越多，这样的函数使用效率高，但不能违背函数间的独立性而单纯地追求高扇入。公共模块中的函数及底层函数应该有较高的扇入。 
        较良好的软件结构通常是顶层函数的扇出较高，中层函数的扇出较少，而底层函数则扇入到公共模块中。
        

        检查函数所有参数输入和非参数输入的有效性。

        说明：函数的输入主要有两种：一种是参数输入；另一种是全局变量、数据文件的输入，即非参数输入。函数在使用输入之前，应进行必要的检查。

        函数的功能应该是可以预测的，也就是只要输入数据相同就应产生同样的输出 
        说明：带有内部“存储器”的函数的功能可能是不可预测的，因为它的输出可能取决于内部存储器（如某标记）的状态。这样的函数既不易于理解又不利于测试和维护。在C/C++语言中，函数的static局部变量是函数的内部存储器，有可能使函数的功能不可预测，然而，当某函数的返回值为指针类型时，则必须是STATIC的局部变量的地址作为返回值，若为AUTO类，则返回为错针。 
        示例：如下函数，其返回值（即功能）是不可预测的。 
       unsigned int integer_sum( unsigned int base ) 
        { 
                 unsigned int index; 
                 static unsigned int sum = 0; // 注意，是static类型的。
                                  // 若改为auto类型，则函数即变为可预测。 
                 for (index = 1; index <= base; index++) 
                 {     
                         sum += index; 
                 } 
                 return sum; 
    } 
        在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接口函数本身负责，缺省是由函数调用者负责。说明：对于模块间接口函数的参数的合法性检查这一问题，往往有两个极端现象，即：要么是调用者和被调用者对参数均不作合法性检查，结果就遗漏了合法性检查这一必要的处理过程，造成问题隐患；要么就是调用者和被调用者均对参数进行合法性检查，这种情况虽不会造成问题，但产生了冗余代码，降低了效率。 
        什么是可重入性？ 
        可重入（reentrant）函数可以由多于一个任务并发使用，而不必担心数据错误。相反， 不可重入（non-reentrant）函数不能由超过一个任务所共享，除非能确保函数的互斥（或者使用信号量，或者在代码的关键部分禁用中断）。可重入函数可以在任意时刻被中断，稍后再继续运行，不会丢失数据。可重入函数要么使用本地变量，要么在使用全局变量时保护自己的数据。 
        可重入函数： 
        不为连续的调用持有静态数据。 
        不返回指向静态数据的指针；所有数据都由函数的调用者提供。 
        使用本地数据，或者通过制作全局数据的本地拷贝来保护全局数据。 
        如果必须访问全局变量，记住利用互斥信号量来保护全局变量。 
        绝不调用任何不可重入函数。 
        不可重入函数： 
        函数中使用了静态变量，无论是全局静态变量还是局部静态变量。 
        函数返回静态变量。 
        函数中调用了不可重入函数。 
        函数体内使用了静态的数据结构； 
        函数体内调用了malloc()或者free()函数； 
        函数体内调用了其他标准I/O函数。 
        函数是singleton中的成员函数而且使用了不使用线程独立存储的成员变量 。 
        总的来说，如果一个函数在重入条件下使用了未受保护的共享的资源，那么它是不可重入的。