引用一: 文件開(kāi)頭的注釋模板
/******************************************************************
** 文件名:
** Copyright (c) 1998-1999 *********公司技術(shù)開(kāi)發(fā)部
** 創(chuàng)建人:
** 日　期:
** 修改人:
** 日　期:
** 描　述:
**
** 版　本:
**--------------------------------------------------------------------------
---


******************************************************************/

　　引用二: 函數(shù)開(kāi)頭的注釋模板
/*****************************************************************
** 函數(shù)名:
** 輸　入: a,b,c
**　　 a---
**　　 b---
**　　 c---
** 輸　出: x---
**　　　x 為 1, 表示...
**　　　x 為 0, 表示...
** 功能描述:
** 全局變量:
** 調(diào)用模塊:
** 作　者:
** 日　期:
** 修　改:
** 日　期:
** 版本
****************************************************************/
　　引用三: 程序中的注釋模板
/*----------------------------------------------------------*/
/* 注釋內(nèi)容　　　　　　　　　　　 */
/*----------------------------------------------------------*/
8 程序
a.　　 程序編碼力求簡(jiǎn)潔，結(jié)構(gòu)清晰，避免太多的分支結(jié)構(gòu)及太過(guò)于技巧性的程序，
盡量不采用遞歸模式。
b.　 編寫程序時(shí)，亦必須想好測(cè)試的方法，換句話說(shuō)，”單元測(cè)試” 的測(cè)試方案應(yīng)
在程序編寫時(shí)一并擬好。
c.　 注釋一定要與程序一致。
d.　 版本封存以后的修改一定要將老語(yǔ)句用/* */ 封閉，不能自行刪除或修改,并要
在文件及函數(shù)的修改記錄中加以記錄。
e.　　 程序中每個(gè)block 的開(kāi)頭 ”{" 及 "}” 必須對(duì)齊，嵌套的block 每進(jìn)一套，
縮進(jìn)一個(gè)tab，TAB 為4個(gè)空格,block類型包括if、for、while、do等關(guān)鍵字引出的。
f.　對(duì)于比較大的函數(shù)，每個(gè)block 和特殊的函數(shù)調(diào)用，都必須注明其功能，舉例如下
：
count.divisor = 1193280 / freq;　　　　　　　 //　compute the proper count
OutByte((unsigned short)67, (unsigned char)182);　//　tell 8253 that a
count is coming
OutByte((unsigned short)66, count. c[0]);　　　//　send low-order byte
OutByte((unsigned short)66, count. c[1]);　　　//　send high-order byte

×××××××××××××××××××××××××××××××××××××××
bcb，delphi中的變量命名：
　遵循匈牙利命名法，命
名必須有意義，制定如下規(guī)定
　窗體：以大寫的W開(kāi)始，如About版權(quán)窗體， 命名為WAbout
文件：以大寫的F開(kāi)始，如About版權(quán)窗體，文件命名為FAbout.cpp
按鈕(Button)：如退出按鈕，命名為btnExit
　……
　基類：加base標(biāo)記，如報(bào)表基類,窗體命名為：WBaseRep, 文件命名為FBaseRep.cpp

轉(zhuǎn)貼
> 1. 在.h/.cpp的開(kāi)頭應(yīng)有一段格式統(tǒng)一的說(shuō)明，內(nèi)容包括：
> a. 文件名 (FileName)；
> b. 創(chuàng)建人 (Creater)；
> c. 文件創(chuàng)建時(shí)間 (Date)；
> d. 簡(jiǎn)短說(shuō)明文件功能、用途 (Comment)。
好習(xí)慣
> 2. 除非極其簡(jiǎn)單，否則對(duì)函數(shù)應(yīng)有注釋說(shuō)明。內(nèi)容包括：功能、入口/出口參數(shù)，必
要
> 時(shí)還可有備注或補(bǔ)充說(shuō)明。
還是好習(xí)慣
> 3. 每列代碼的長(zhǎng)度推薦為 80列，最長(zhǎng)不得超過(guò)120列；折行以對(duì)齊為準(zhǔn)。
太寬了，我的限制是60列，因?yàn)槲谋痉绞较缕聊灰还?0列，如果你用BC這一類的編輯
器，窗口邊框等又要占據(jù)一定空間，所以80列太寬
> 4. 循環(huán)、分支代碼，判斷條件與執(zhí)行代碼不得在同一行上。
很對(duì)
> 5. 指針的定義，* 號(hào)既可以緊接類型，也可以在變量名之前。
>
> 例：可寫做：int*　pnsize;
>
> 也可寫做：int　*pnsize;
>
> 但不得寫做：int　*　pnsize;
建議采用第二種，除非附加另外一條規(guī)定：一次只聲明一個(gè)變量，否則就會(huì)讓人混淆，
比如：
int* a, b;
看起來(lái)b好像也是個(gè)指針，其實(shí)不是。
> 6. 在類的成員函數(shù)內(nèi)調(diào)用非成員函數(shù)時(shí)，在非成員函數(shù)名前必須加上"::"。
這一條我倒覺(jué)得并不是必需的，我的看法是決不要讓你的類成員函數(shù)和全局函數(shù)的名稱
相同（或類似）
> 7. 函數(shù)入口參數(shù)有缺省值時(shí)，應(yīng)注釋說(shuō)明。
>
> 例：BOOL CWpsDib::PaintDIB(CDC* pDC, CRect& rc,
>　　　int nBrightness, file://*=0*//
>　　　BOOL bGrayScale file://*=FALSE*// )
每個(gè)變量寫一行，必要時(shí)加上/*in, out*/注釋
> 8. else　if 必須寫在一行。
應(yīng)該盡量避免else if這樣的結(jié)構(gòu)
> 9. 與‘{’、‘}’有關(guān)的各項(xiàng)規(guī)定：
>
>　9.1‘{’、‘}’應(yīng)獨(dú)占一行。在該行內(nèi)可有注釋。
> 9.2 ‘{’必須另起一行，‘{’ 之后的代碼必須縮進(jìn)一個(gè)Tab。‘{’與‘}’必須在
同
> 一列上。
> 9.3 在循環(huán)、分支之后若只有一行代碼，雖然可省略‘{’、‘}’，但不推薦這么
> 做。若省略后可能引起歧義，則必須加上‘{’、‘}’。
持保留意見(jiàn)，因?yàn)镚NU的代碼規(guī)范是這樣的：
if ( NULL == ptr )
　　{
　　　　// do something here
　　}
或者
if ( NULL == ptr ) {
　　　　// do something here
}
爭(zhēng)論哪個(gè)更好并沒(méi)有意義，關(guān)鍵是統(tǒng)一，如果用VC當(dāng)然你的辦法最方便，可是如果你用
emacs或者vi，就不是這樣了。
> 10. 與空格有關(guān)的各項(xiàng)規(guī)定。
>
> 10.1 在所有兩目、三目運(yùn)算符的兩邊都必須有空格。在單目運(yùn)算符兩端不必空格。
但
> 在‘—>’、‘::’、‘.’、‘[’、‘]’等運(yùn)算符前后，及‘&’（取地址）、‘*
> ’（取值）等運(yùn)算符之后不得有空格。
> 10.2　for、while、if 等關(guān)鍵詞之后應(yīng)有1個(gè)空格，再接‘(’，之后無(wú)空格；在結(jié)
尾
> 的‘)’前不得有空格。

我認(rèn)為在括號(hào)兩端加空格并不是什么錯(cuò)誤，尤其是在一個(gè)條件十分復(fù)雜的if語(yǔ)句里
> 10.3 調(diào)用函數(shù)、宏時(shí)，‘(’、‘)’前后不得有空格。
> 10.4　類型強(qiáng)制轉(zhuǎn)換時(shí)，‘(’‘)’前后不得有空格
同上
> 11. 與縮進(jìn)有關(guān)的各項(xiàng)規(guī)定
>
> 11.1 縮進(jìn)以 Tab 為單位。1 個(gè) Tab 為 4 個(gè)空格
我認(rèn)為這個(gè)值應(yīng)該更大，我自己使用8個(gè)空格，如果你的代碼因?yàn)榭s進(jìn)幅度太大而導(dǎo)致
折行，那么幾乎可以肯定你的程序設(shè)計(jì)方案有問(wèn)題。
> 11.2 下列情況，代碼縮進(jìn)一個(gè) Tab:
> 1. 函數(shù)體相對(duì)函數(shù)名及'{'、'}'。
> 2. if、else、for、while、do 等之后的代碼。
> 3. 一行之內(nèi)寫不下，折行之后的代碼，應(yīng)在合理的位置進(jìn)行折行。若有 + - * / 等
運(yùn)
> 算符，則運(yùn)算符應(yīng)在上一行末尾，而不應(yīng)在下一行的行首。
這一條我反對(duì)，運(yùn)算符應(yīng)該放在下一行行首，以使人能清楚的知道這一行是續(xù)上一行
的，比如
if ( something
　　&& somethingelse
　　&& otherthings )
如果寫做
if ( something &&
　　somethingelse &&
　　otherthings )
反而看不清楚
> 11.3 下列情況，不必縮進(jìn)：switch 之后的 case、default。