需要林銳《高質(zhì)量編程指南》原文的請(qǐng)?jiān)诨貜?fù)中留下電子郵箱.請(qǐng)?jiān)谘咐字凶孕兴阉?

11月14日
1.頭文件規(guī)范:
如:

 

2.【規(guī)則】一行代碼只做一件事情，如只定義一個(gè)變量，或只寫(xiě)一條語(yǔ)句。這樣的代碼容易閱讀，并且方便于寫(xiě)注釋。如:

int width; // 寬度
int height; // 高度
int depth; // 深度
x = a + b;
y = c + d;
z = e + f;
if (width < height)
{
dosomething();
}
for (initialization; condition; update)
{
dosomething();
}
// 空行
other();

 

3.【建議】盡可能在定義變量的同時(shí)初始化該變量（就近原則）
如:

 

4.空格寫(xiě)法:
 【規(guī)則】if、for、while等關(guān)鍵字之后應(yīng)留一個(gè)空格再跟左括號(hào)‘（’，以突出關(guān)鍵字。

 【規(guī)則】函數(shù)名之后不要留空格，緊跟左括號(hào)‘（’，以與關(guān)鍵字區(qū)別。

 【規(guī)則】‘（’向后緊跟，‘）’、‘，’、‘;’向前緊跟，緊跟處不留空格。

 【規(guī)則】‘，’之后要留空格，如Function(x, y, z)。如果‘;’不是一行的結(jié)束符號(hào)，其后要留空格，如for (initialization; condition; update)。

 【規(guī)則】賦值操作符、比較操作符、算術(shù)操作符、邏輯操作符、位域操作符，如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后應(yīng)當(dāng)加空格。

 【規(guī)則】一元操作符如“!”、“~”、“++”、“--”、“&”（地址運(yùn)算符）等前后不加空格。

 

5.【建議】對(duì)于表達(dá)式比較長(zhǎng)的for語(yǔ)句和if語(yǔ)句，為了緊湊起見(jiàn)可以適當(dāng)?shù)厝サ粢恍┛崭瘢鏵or (i=0; i<10; i++)和if ((a<=b) && (c<=d))

 

6.長(zhǎng)行拆分:
 【規(guī)則】長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀。

 

7.應(yīng)當(dāng)將修飾符 * 和 ＆ 緊靠變量名
例如：
char  *name;
int   *x, y; // 此處y不會(huì)被誤解為指針

 

8.注釋的寫(xiě)法:
   程序塊的注釋常采用“/*…*/”，行注釋一般采用“//…”。

 【規(guī)則】注釋是對(duì)代碼的“提示”，而不是文檔。程序中的注釋不可喧賓奪主，注釋太多了會(huì)讓人眼花繚亂。注釋的花樣要少。

 【規(guī)則】邊寫(xiě)代碼邊注釋

 【規(guī)則】注釋的位置應(yīng)與被描述的代碼相鄰，可以放在代碼的上方或右方，不可放在下方。

 

9.類的版式:
   我們不可以濫用類的封裝功能，不要把它當(dāng)成火鍋，什么東西都往里扔。
   將public類型的函數(shù)寫(xiě)在前面，而將private類型的數(shù)據(jù)寫(xiě)在后面，“以行為為中心”，重點(diǎn)關(guān)注的是類應(yīng)該提供什么樣的接口（或服務(wù)）。

 

10.命名規(guī)則:
   切忌使用漢語(yǔ)拼音來(lái)命名。
 【規(guī)則】命名規(guī)則盡量與所采用的操作系統(tǒng)或開(kāi)發(fā)工具的風(fēng)格保持一致。
   例如Windows應(yīng)用程序的標(biāo)識(shí)符通常采用“大小寫(xiě)”混排的方式，如AddChild。而Unix應(yīng)用程序的標(biāo)識(shí)符通常采用“小寫(xiě)加下劃線”的方式，如add_child。別把這兩類風(fēng)格混在一起用。
 【規(guī)則】變量的名字應(yīng)當(dāng)使用“名詞”或者“形容詞＋名詞”。
例如：

 【規(guī)則】全局函數(shù)的名字應(yīng)當(dāng)使用“動(dòng)詞”或者“動(dòng)詞＋名詞”（動(dòng)賓詞組）。類的成員函數(shù)應(yīng)當(dāng)只使用“動(dòng)詞”，被省略掉的名詞就是對(duì)象本身。
例如：
DrawBox();  // 全局函數(shù)
box->Draw();  // 類的成員函數(shù)

 【建議】盡量避免名字中出現(xiàn)數(shù)字編號(hào)，如Value1,Value2等，除非邏輯上的確需要編號(hào)。這是為了防止程序員偷懶，不肯為命名動(dòng)腦筋而導(dǎo)致產(chǎn)生無(wú)意義的名字（因?yàn)橛脭?shù)字編號(hào)最省事）。

11月24日
1.簡(jiǎn)單的Windows應(yīng)用程序命名規(guī)則:
【規(guī)則】類名和函數(shù)名用大寫(xiě)字母開(kāi)頭的單詞組合而成。
例如：
 class Node;   // 類名
 void  SetValue(int value); // 函數(shù)名

【規(guī)則】變量和參數(shù)用小寫(xiě)字母開(kāi)頭的單詞組合而成。
例如：
 BOOL flag;
 int  drawMode;

【規(guī)則】常量全用大寫(xiě)的字母，用下劃線分割單詞。
例如：
 const int MAX = 100;
 const int MAX_LENGTH = 100;

【規(guī)則】靜態(tài)變量加前綴s_（表示static）。
例如：
 static int s_initValue; // 靜態(tài)變量
【規(guī)則】全局變量加前綴g_（表示global）。

【規(guī)則】類的數(shù)據(jù)成員加前綴m_（表示member），這樣可以避免數(shù)據(jù)成員與成員函數(shù)的參數(shù)同名。

 

2.允許復(fù)合表達(dá)式存在的理由是：（1）書(shū)寫(xiě)簡(jiǎn)潔；（2）可以提高編譯效率。但要防止濫用復(fù)合表達(dá)式。

 

3.布爾變量與零值比較:
【規(guī)則1】不可將布爾變量直接與TRUE、FALSE或者1、0進(jìn)行比較。
    根據(jù)布爾類型的語(yǔ)義，零值為“假”（記為FALSE），任何非零值都是“真”（記為TRUE）。TRUE的值究竟是什么并沒(méi)有統(tǒng)一的標(biāo)準(zhǔn)。例如Visual C++ 將TRUE定義為1，而Visual Basic則將TRUE定義為-1。
假設(shè)布爾變量名字為flag，它與零值比較的標(biāo)準(zhǔn)if語(yǔ)句如下：
if (flag) // 表示flag為真
if (!flag) // 表示flag為假
其它的用法都屬于不良風(fēng)格，例如：
 if (flag == TRUE) 
 if (flag == 1 )  
 if (flag == FALSE) 
 if (flag == 0) 

對(duì)于林銳提出的規(guī)則我有質(zhì)疑,既然bool型的值按定義記為FALSE和TRUE,
那么我根本不關(guān)心FALSE和TRUE的具體值,那么
 if (flag == TRUE)  
又有何不可?系統(tǒng)總不會(huì)把TRUE定義為0吧?(如果是這樣,林銳還是對(duì)的)

 

4.整型變量與零值比較:
【規(guī)則】應(yīng)當(dāng)將整型變量用“==”或“！=”直接與0比較。
與零值比較的標(biāo)準(zhǔn)if語(yǔ)句如下：
if (value == 0) 
if (value != 0)
不可模仿布爾變量的風(fēng)格而寫(xiě)成
if (value)  // 會(huì)讓人誤解 value是布爾變量
if (!value)

 

5.浮點(diǎn)變量與零值比較:
if ((x>=-EPSINON) && (x<=EPSINON))

 

6.指針變量與零值比較:
if (p == NULL) // p與NULL顯式比較，強(qiáng)調(diào)p是指針變量
if (p != NULL) 

 

7.為防止出錯(cuò):
為了防止將 if (p == NULL) 誤寫(xiě)成 if (p = NULL)，而有意把p和NULL顛倒。
編譯器認(rèn)為 if (p = NULL) 是合法的，但是會(huì)指出 if (NULL = p)是錯(cuò)誤的，
因?yàn)镹ULL不能被賦值。

if (condition) //不良風(fēng)格,容易出錯(cuò)
 return x;
return y;
改寫(xiě)為
if (condition)
{
 return x;
}
else
{
 return y;
}
或者改寫(xiě)成更加簡(jiǎn)練的
return (condition ? x : y);

 

8.循環(huán)語(yǔ)句的效率:
【建議】在多重循環(huán)中，如果有可能，應(yīng)當(dāng)將最長(zhǎng)的循環(huán)放在最內(nèi)層，最短的循環(huán)放在最外層，以減少CPU跨切循環(huán)層的次數(shù)。
【建議】如果循環(huán)體內(nèi)存在邏輯判斷，并且循環(huán)次數(shù)很大，宜將邏輯判斷移到循環(huán)體的外面。
如果老要進(jìn)行邏輯判斷，打斷了循環(huán)“流水線”作業(yè)，使得編譯器不能對(duì)循環(huán)進(jìn)行優(yōu)化處理，降低了效率。
但缺點(diǎn)是:程序不簡(jiǎn)潔.

 

9.【建議】建議for語(yǔ)句的循環(huán)控制變量的取值采用“半開(kāi)半閉區(qū)間”寫(xiě)法。
x值屬于半開(kāi)半閉區(qū)間“0 =< x < N”，起點(diǎn)到終點(diǎn)的間隔為N，循環(huán)次數(shù)為N。非常直觀簡(jiǎn)潔.

 

10.【規(guī)則】不要忘記最后那個(gè)default分支。即使程序真的不需要default處理，也應(yīng)該保留語(yǔ)句
 default : break;
這樣做并非多此一舉，而是為了防止別人誤以為你忘了default處理。

 

11.goto的討論:
很多人建議廢除C++/C的goto語(yǔ)句，以絕后患。但實(shí)事求是地說(shuō)，錯(cuò)誤是程序員自己造成的，不是goto的過(guò)錯(cuò)。goto 語(yǔ)句至少有一處可顯神通，它能從多重循環(huán)體中咻地一下子跳到外面，用不著寫(xiě)很多次的break語(yǔ)句;
就象樓房著火了，來(lái)不及從樓梯一級(jí)一級(jí)往下走，可從窗口跳出火坑。所以我們主張少用、慎用goto語(yǔ)句，而不是禁用。

 

12.常量的討論:
C語(yǔ)言用 #define來(lái)定義常量（稱為宏常量）。
C++ 語(yǔ)言除了 #define外還可以用const來(lái)定義常量（稱為const常量）。

在C++中,const定義常量的優(yōu)勢(shì):
1)類型檢查
2)可以調(diào)試
    故可以規(guī)定:
【規(guī)則】在C++ 程序中只使用const常量而不使用宏常量，即const常量完全取代宏常量。

【規(guī)則】需要對(duì)外公開(kāi)的常量放在頭文件中，不需要對(duì)外公開(kāi)的常量放在定義文件的頭部(cpp文件)。
為便于管理，可以把不同模塊的常量集中存放在一個(gè)公共的頭文件中。

類中使用const常量:
1)不能在類聲明中初始化const數(shù)據(jù)成員。
  因?yàn)轭惖膶?duì)象未被創(chuàng)建時(shí)，編譯器不知道該成員的值是什么。
  const數(shù)據(jù)成員的初始化只能在類構(gòu)造函數(shù)的初始化表中進(jìn)行.
2)const數(shù)據(jù)成員只在某個(gè)對(duì)象生存期內(nèi)是常量，而對(duì)于整個(gè)類而言卻是可變的，
  因?yàn)轭惪梢詣?chuàng)建多個(gè)對(duì)象，不同的對(duì)象其const數(shù)據(jù)成員的值可以不同。
3)怎樣才能建立在整個(gè)類中都恒定的常量呢？
  別指望const數(shù)據(jù)成員了，應(yīng)該用類中的枚舉常量來(lái)實(shí)現(xiàn)。
  但是缺點(diǎn)很明顯,只能表示有限大小的整型值.

 

13.函數(shù)設(shè)計(jì):
C語(yǔ)言中，函數(shù)的參數(shù)和返回值的傳遞方式有兩種：
值傳遞（pass by value）和指針傳遞（pass by pointer）。
C++ 語(yǔ)言中多了引用傳遞（pass by reference）。

 

14.風(fēng)格:
【規(guī)則】:
void SetValue(int width, int height); // 良好的風(fēng)格
void SetValue(int, int);  // 不良的風(fēng)格
float GetValue(void);  // 良好的風(fēng)格
float GetValue();  // 不良的風(fēng)格

【規(guī)則】參數(shù)命名要恰當(dāng)，順序要合理。
一般地，應(yīng)將目的參數(shù)放在前面，源參數(shù)放在后面。
如果將函數(shù)聲明為：
void StringCopy(char *strDestination, char *strSource);

【規(guī)則】如果參數(shù)是指針，且僅作輸入用，則應(yīng)在類型前加const，以防止該指針在函數(shù)體內(nèi)被意外修改。
例如：
void StringCopy(char *strDestination，const char *strSource);

【規(guī)則】如果輸入?yún)?shù)以值傳遞的方式傳遞對(duì)象，則宜改用“const &”方式來(lái)傳遞，這樣可以省去臨時(shí)對(duì)象的構(gòu)造和析構(gòu)過(guò)程，從而提高效率。
@#$%:const & 怎么用?

【規(guī)則】不要將正常值和錯(cuò)誤標(biāo)志混在一起返回。正常值用輸出參數(shù)獲得，而錯(cuò)誤標(biāo)志用return語(yǔ)句返回。
典型的getchar函數(shù):
可由 int getchar(void);  //字符型值和終止值EOF一同返回,不良風(fēng)格,但用起來(lái)方便
改為    BOOL GetChar(char *c);

【建議】有時(shí)候函數(shù)原本不需要返回值，但為了增加靈活性如支持鏈?zhǔn)奖磉_(dá)，可以附加返回值。
char *strcpy(char *strDest，const char *strSrc);