一、可重入函數(shù)
1）什么是可重入性？
可重入（reentrant）函數(shù)可以由多于一個任務并發(fā)使用，而不必擔心數(shù)據(jù)錯誤。相反，
不可重入（non-reentrant）函數(shù)不能由超過一個任務所共享，除非能確保函數(shù)的互斥（或者使用信號量，或者在代碼的關鍵部分禁用中斷）。可重入
函數(shù)可以在任意時刻被中斷，稍后再繼續(xù)運行，不會丟失數(shù)據(jù)?？芍厝牒瘮?shù)要么使用本地變量，要么在使用全局變量時保護自己的數(shù)據(jù)。
2）可重入函數(shù)：
不為連續(xù)的調用持有靜態(tài)數(shù)據(jù)。
不返回指向靜態(tài)數(shù)據(jù)的指針；所有數(shù)據(jù)都由函數(shù)的調用者提供。
使用本地數(shù)據(jù)，或者通過制作全局數(shù)據(jù)的本地拷貝來保護全局數(shù)據(jù)。
如果必須訪問全局變量，記住利用互斥信號量來保護全局變量。
絕不調用任何不可重入函數(shù)。
3）不可重入函數(shù)：
函數(shù)中使用了靜態(tài)變量，無論是全局靜態(tài)變量還是局部靜態(tài)變量。
函數(shù)返回靜態(tài)變量。
函數(shù)中調用了不可重入函數(shù)。
函數(shù)體內使用了靜態(tài)的數(shù)據(jù)結構；
函數(shù)體內調用了malloc()或者free()函數(shù)；
函數(shù)體內調用了其他標準I/O函數(shù)。
函數(shù)是singleton中的成員函數(shù)而且使用了不使用線程獨立存儲的成員變量 。
總的來說，如果一個函數(shù)在重入條件下使用了未受保護的共享的資源，那么它是不可重入的。
4）示例
在多線程條件下，函數(shù)應當是線程安全的，進一步，更強的條件是可重入的。可重入函數(shù)保證了在多線程條件下，函數(shù)的狀態(tài)不會出現(xiàn)錯誤。以下分別是一個不可重入和可重入函數(shù)的示例：
//c code
static int tmp;
void func1(int* x, int* y) {
tmp=*x;
*x=*y;
*y=tmp;
}
void func2(int* x, int* y) {
int tmp;
tmp=*x;
*x=*y;
*y=tmp;
}
func1是不可重入的，func2是可重入的。因為在多線程條件下，操作系統(tǒng)會在func1還沒有執(zhí)行完的情況下，切換到另一個線程中，那個線程可能再次調用func1，這樣狀態(tài)就錯了。
二、函數(shù)編寫規(guī)范
1 ：對所調用函數(shù)的錯誤返回碼要仔細、全面地處理
2 ：明確函數(shù)功能，精確（而不是近似）地實現(xiàn)函數(shù)設計
3 ：編寫可重入函數(shù)時，應注意局部變量的使用（如編寫C/C++ 語言的可重入函數(shù)時，應使用auto 即缺省態(tài)局部變量或寄存器變量）
說明：編寫C/C++語言的可重入函數(shù)時，不應使用static局部變量，否則必須經過特殊處理，才能使函數(shù)具有可重入性。
4 ：編寫可重入函數(shù)時，若使用全局變量，則應通過關中斷、信號量（即P 、V 操作）等手段對其加以保護
說明：若對所使用的全局變量不加以保護，則此函數(shù)就不具有可重入性，即當多個進程調用此函數(shù)時，很有可能使有關全局變量變?yōu)椴豢芍獱顟B(tài)。
示例：假設Exam是int型全局變量，函數(shù)Squre_Exam返回Exam平方值。那么如下函數(shù)不具有可重入性。
unsigned int example( int para )
{
unsigned int temp;
Exam = para; // （**）
temp = Square_Exam( );
return temp;
}
此
函數(shù)若被多個進程調用的話，其結果可能是未知的，因為當（**）語句剛執(zhí)行完后，另外一個使用本函數(shù)的進程可能正好被激活，那么當新激活的進程執(zhí)行到此函
數(shù)時，將使Exam賦與另一個不同的para值，所以當控制重新回到“temp = Square_Exam(
)”后，計算出的temp很可能不是預想中的結果。此函數(shù)應如下改進。
unsigned int example( int para )
{
unsigned int temp;
[申請信號量操作] // 若申請不到“信號量”，說明另外的進程正處于
Exam = para; // 給Exam賦值并計算其平方過程中（即正在使用此
temp = Square_Exam( ); // 信號），本進程必須等待其釋放信號后，才可繼
[釋放信號量操作] // 續(xù)執(zhí)行。若申請到信號，則可繼續(xù)執(zhí)行，但其
// 它進程必須等待本進程釋放信號量后，才能再使
// 用本信號。
return temp;
}
5 ：在同一項目組應明確規(guī)定對接口函數(shù)參數(shù)的合法性檢查應由函數(shù)的調用者負責還是由接口函數(shù)本身負責，缺省是由函數(shù)調用者負責
說
明：對于模塊間接口函數(shù)的參數(shù)的合法性檢查這一問題，往往有兩個極端現(xiàn)象，即：要么是調用者和被調用者對參數(shù)均不作合法性檢查，結果就遺漏了合法性檢查這
一必要的處理過程，造成問題隱患；要么就是調用者和被調用者均對參數(shù)進行合法性檢查，這種情況雖不會造成問題，但產生了冗余代碼，降低了效率。
6 ：防止將函數(shù)的參數(shù)作為工作變量
說明：將函數(shù)的參數(shù)作為工作變量，有可能錯誤地改變參數(shù)內容，所以很危險。對必須改變的參數(shù)，最好先用局部變量代之，最后再將該局部變量的內容賦給該參數(shù)。
示例：如下函數(shù)的實現(xiàn)就不太好。
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;
}
7 ：函數(shù)的規(guī)模盡量限制在200 行以內
說明：不包括注釋和空格行。
8 ：一個函數(shù)僅完成一件功能
9 ：為簡單功能編寫函數(shù)
說明：雖然為僅用一兩行就可完成的功能去編函數(shù)好象沒有必要，但用函數(shù)可使功能明確化，增加程序可讀性，亦可方便維護、測試。
示例：如下語句的功能不很明顯。
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);
10：不要設計多用途面面俱到的函數(shù)
說明：多功能集于一身的函數(shù)，很可能使函數(shù)的理解、測試、維護等變得困難。
11：函數(shù)的功能應該是可以預測的，也就是只要輸入數(shù)據(jù)相同就應產生同樣的輸出
說
明：帶有內部“存儲器”的函數(shù)的功能可能是不可預測的，因為它的輸出可能取決于內部存儲器（如某標記）的狀態(tài)。這樣的函數(shù)既不易于理解又不利于測試和維
護。在C/C++語言中，函數(shù)的static局部變量是函數(shù)的內部存儲器，有可能使函數(shù)的功能不可預測，然而，當某函數(shù)的返回值為指針類型時，則必須是
STATIC的局部變量的地址作為返回值，若為AUTO類，則返回為錯針。
示例：如下函數(shù)，其返回值（即功能）是不可預測的。
unsigned int integer_sum( unsigned int base )
{
unsigned int index;
static unsigned int sum = 0; // 注意，是static類型的。
// 若改為auto類型，則函數(shù)即變?yōu)榭深A測。
for (index = 1; index <= base; index++)
{
sum += index;
}
return sum;
}
12 ：盡量不要編寫依賴于其他函數(shù)內部實現(xiàn)的函數(shù)
說明：此條為函數(shù)獨立性的基本要求。由于目前大部分高級語言都是結構化的，所以通過具體語言的語法要求與編譯器功能，基本就可以防止這種情況發(fā)生。但在匯編語言中，由于其靈活性，很可能使函數(shù)出現(xiàn)這種情況。
示例：如下是在DOS下TASM的匯編程序例子。過程Print_Msg的實現(xiàn)依賴于Input_Msg的具體實現(xiàn)，這種程序是非結構化的，難以維護、修改。
... // 程序代碼
proc Print_Msg // 過程（函數(shù)）Print_Msg
... // 程序代碼
jmp LABEL
... // 程序代碼
endp
proc Input_Msg // 過程（函數(shù)）Input_Msg
... // 程序代碼
LABEL:
... // 程序代碼
endp
13 ：避免設計多參數(shù)函數(shù)，不使用的參數(shù)從接口中去掉
說明：目的減少函數(shù)間接口的復雜度。
14 ：非調度函數(shù)應減少或防止控制參數(shù)，盡量只使用數(shù)據(jù)參數(shù)
說
明：本建議目的是防止函數(shù)間的控制耦合。調度函數(shù)是指根據(jù)輸入的消息類型或控制命令，來啟動相應的功能實體（即函數(shù)或過程），而本身并不完成具體功能?？?
制參數(shù)是指改變函數(shù)功能行為的參數(shù)，即函數(shù)要根據(jù)此參數(shù)來決定具體怎樣工作。非調度函數(shù)的控制參數(shù)增加了函數(shù)間的控制耦合，很可能使函數(shù)間的耦合度增大，
并使函數(shù)的功能不唯一。
示例：如下函數(shù)構造不太合理。
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);
}
}
不如分為如下兩個函數(shù)清晰。
int add( int a, int b )
{
return (a + b);
}
int sub( int a, int b )
{
return (a b);
}
15 ：檢查函數(shù)所有參數(shù)輸入的有效性
16 ：檢查函數(shù)所有非參數(shù)輸入的有效性，如數(shù)據(jù)文件、公共變量等
說明：函數(shù)的輸入主要有兩種：一種是參數(shù)輸入；另一種是全局變量、數(shù)據(jù)文件的輸入，即非參數(shù)輸入。函數(shù)在使用輸入之前，應進行必要的檢查。
17 ：函數(shù)名應準確描述函數(shù)的功能
18 ：使用動賓詞組為執(zhí)行某操作的函數(shù)命名。如果是OOP 方法，可以只有動詞（名詞是對象本身）
示例：參照如下方式命名函數(shù)。
void print_record( unsigned int rec_ind ) ;
int input_record( void ) ;
unsigned char get_current_color( void ) ;
19 ：避免使用無意義或含義不清的動詞為函數(shù)命名
說明：避免用含義不清的動詞如process、handle等為函數(shù)命名，因為這些動詞并沒有說明要具體做什么。
20 ：函數(shù)的返回值要清楚、明了，讓使用者不容易忽視錯誤情況
說明：函數(shù)的每種出錯返回值的意義要清晰、明了、準確，防止使用者誤用、理解錯誤或忽視錯誤返回碼。
21 ：除非必要，最好不要把與函數(shù)返回值類型不同的變量，以編譯系統(tǒng)默認的轉換方式或強制的轉換方式作為返回值返回
22 ：讓函數(shù)在調用點顯得易懂、容易理解
23 ：在調用函數(shù)填寫參數(shù)時，應盡量減少沒有必要的默認數(shù)據(jù)類型轉換或強制數(shù)據(jù)類型轉換
說明：因為數(shù)據(jù)類型轉換或多或少存在危險。
24 ：避免函數(shù)中不必要語句，防止程序中的垃圾代碼
說明：程序中的垃圾代碼不僅占用額外的空間，而且還常常影響程序的功能與性能，很可能給程序的測試、維護等造成不必要的麻煩。
25 ：防止把沒有關聯(lián)的語句放到一個函數(shù)中
說
明：防止函數(shù)或過程內出現(xiàn)隨機內聚。隨機內聚是指將沒有關聯(lián)或關聯(lián)很弱的語句放到同一個函數(shù)或過程中。隨機內聚給函數(shù)或過程的維護、測試及以后的升級等造
成了不便，同時也使函數(shù)或過程的功能不明確。使用隨機內聚函數(shù)，常常容易出現(xiàn)在一種應用場合需要改進此函數(shù)，而另一種應用場合又不允許這種改進，從而陷入
困境。
在編程時，經常遇到在不同函數(shù)中使用相同的代碼，許多開發(fā)人員都愿把這些代碼提出來，并構成一個新函數(shù)。若這些代碼關聯(lián)較大并且是完成一個功能的，那么這種構造是合理的，否則這種構造將產生隨機內聚的函數(shù)。
示例：如下函數(shù)就是一種隨機內聚。
void Init_Var( void )
{
Rect.length = 0;
Rect.width = 0; /* 初始化矩形的長與寬 */
Point.x = 10;
Point.y = 10; /* 初始化“點”的坐標 */
}
矩形的長、寬與點的坐標基本沒有任何關系，故以上函數(shù)是隨機內聚。
應如下分為兩個函數(shù)：
void Init_Rect( void )
{
Rect.length = 0;
Rect.width = 0; /* 初始化矩形的長與寬 */
}
void Init_Point( void )
{
Point.x = 10;
Point.y = 10; /* 初始化“點”的坐標 */
}
26：如果多段代碼重復做同一件事情，那么在函數(shù)的劃分上可能存在問題
說明：若此段代碼各語句之間有實質性關聯(lián)并且是完成同一件功能的，那么可考慮把此段代碼構造成一個新的函數(shù)。
27：功能不明確較小的函數(shù)，特別是僅有一個上級函數(shù)調用它時，應考慮把它合并到上級函數(shù)中，而不必單獨存在
說明：模塊中函數(shù)劃分的過多，一般會使函數(shù)間的接口變得復雜。所以過小的函數(shù)，特別是扇入很低的或功能不明確的函數(shù)，不值得單獨存在。
28 ：設計高扇入、合理扇出（小于7 ）的函數(shù)
說明：扇出是指一個函數(shù)直接調用（控制）其它函數(shù)的數(shù)目，而扇入是指有多少上級函數(shù)調用它。
扇
出過大，表明函數(shù)過分復雜，需要控制和協(xié)調過多的下級函數(shù)；而扇出過小，如總是1，表明函數(shù)的調用層次可能過多，這樣不利程序閱讀和函數(shù)結構的分析，并且
程序運行時會對系統(tǒng)資源如堆?？臻g等造成壓力。函數(shù)較合理的扇出（調度函數(shù)除外）通常是3-5。扇出太大，一般是由于缺乏中間層次，可適當增加中間層次的
函數(shù)。扇出太小，可把下級函數(shù)進一步分解多個函數(shù)，或合并到上級函數(shù)中。當然分解或合并函數(shù)時，不能改變要實現(xiàn)的功能，也不能違背函數(shù)間的獨立性。
扇入越大，表明使用此函數(shù)的上級函數(shù)越多，這樣的函數(shù)使用效率高，但不能違背函數(shù)間的獨立性而單純地追求高扇入。公共模塊中的函數(shù)及底層函數(shù)應該有較高的扇入。
較良好的軟件結構通常是頂層函數(shù)的扇出較高，中層函數(shù)的扇出較少，而底層函數(shù)則扇入到公共模塊中。
29 ：減少函數(shù)本身或函數(shù)間的遞歸調用
說明：遞歸調用特別是函數(shù)間的遞歸調用（如A->B->C->A），影響程序的可理解性；遞歸調用一般都占用較多的系統(tǒng)資源（如棧空間）；遞歸調用對程序的測試有一定影響。故除非為某些算法或功能的實現(xiàn)方便，應減少沒必要的遞歸調用。
30 ：仔細分析模塊的功能及性能需求，并進一步細分，同時若有必要畫出有關數(shù)據(jù)流圖，據(jù)此來進行模塊的函數(shù)劃分與組織
說明：函數(shù)的劃分與組織是模塊的實現(xiàn)過程中很關鍵的步驟，如何劃分出合理的函數(shù)結構，關系到模塊的最終效率和可維護性、可測性等。根據(jù)模塊的功能圖或/及數(shù)據(jù)流圖映射出函數(shù)結構是常用方法之一。
31 ：改進模塊中函數(shù)的結構，降低函數(shù)間的耦合度，并提高函數(shù)的獨立性以及代碼可讀性、效率和可維護性
優(yōu)化函數(shù)結構時，要遵守以下原則：
（1）不能影響模塊功能的實現(xiàn)。
（2）仔細考查模塊或函數(shù)出錯處理及模塊的性能要求并進行完善。
（3）通過分解或合并函數(shù)來改進軟件結構。
（4）考查函數(shù)的規(guī)模，過大的要進行分解。
（5）降低函數(shù)間接口的復雜度。
（6）不同層次的函數(shù)調用要有較合理的扇入、扇出。
（7）函數(shù)功能應可預測。
（8）提高函數(shù)內聚。（單一功能的函數(shù)內聚最高）
說明：對初步劃分后的函數(shù)結構應進行改進、優(yōu)化，使之更為合理。
32 ：在多任務操作系統(tǒng)的環(huán)境下編程，要注意函數(shù)可重入性的構造
說
明：可重入性是指函數(shù)可以被多個任務進程調用。在多任務操作系統(tǒng)中，函數(shù)是否具有可重入性是非常重要的，因為這是多個進程可以共用此函數(shù)的必要條件。另
外，編譯器是否提供可重入函數(shù)庫，與它所服務的操作系統(tǒng)有關，只有操作系統(tǒng)是多任務時，編譯器才有可能提供可重入函數(shù)庫。如DOS下BC和MSC等就不具
備可重入函數(shù)庫，因為DOS是單用戶單任務操作系統(tǒng)。
33 ：避免使用BOOL 參數(shù)
說明：原因有二，其一是BOOL參數(shù)值無意義，TURE/FALSE的含義是非常模糊的，在調用時很難知道該參數(shù)到底傳達的是什么意思；其二是BOOL參數(shù)值不利于擴充。還有NULL也是一個無意義的單詞。
34 ： 對于提供了返回值的函數(shù)，在引用時最好使用其返回值
35 ：當一個過程（函數(shù)）中對較長變量（一般是結構的成員）有較多引用時，可以用一個意義相當?shù)暮甏?
說明：這樣可以增加編程效率和程序的可讀性。
示例：在某過程中較多引用TheReceiveBuffer[FirstSocket].byDataPtr，
則可以通過以下宏定義來代替：
# define pSOCKDATA TheReceiveBuffer[FirstScoket].byDataPtr
Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=729126