代碼規範制定

目錄

• 縮進
• 變量命名
• 每行最多字元數
• 函數最大行
• 函數、類命名
• 常量
• 空行規則
• 注釋規則
• 操作符前後空格
• 其他規則

程式塊要采用縮進風格編寫，縮進的空格數為4個。

如果使用TAB鍵，要設定空格數為4格。

使用正确的英文單詞，可以讓讀者易于了解,力求簡單清楚，避免使用引起誤解的詞彙和模糊的使人産生誤解.

采用駝峰命名法

變量的命名采用“小駝峰法”，如：camelCase，即第一個單詞全小寫，後面單詞首字母大寫。

較長的語句（>80字元）要分成多行書寫。

不超過120行

函數的命名，使用英文單詞盡量可以描述該函數主要功能,可采用（動-名）或者（謂-賓）的結構。

二者皆采用大駝峰命名法，即所有單詞首字母都大寫。

如下形式例外（領域模型的相關命名）：

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。

1. 相對獨立的程式塊之間要使用空行分開；
2. 變量聲明應盡可能靠近第一次使用處，避免一次性聲明一組沒有馬上使用的變量。
3. 函數間要使用空行分開；

4. 每個類聲明之後應該加入空格同

   其他代碼分開

1. 注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方（對單條語句的

   注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。

2. 注釋要與内容有相同的縮排
3. 注釋要與上面無關的代碼用空行隔開
4. 變量與常量的注釋放在其右方
5. 在源檔案頭部應列出，生成日期、作者、代碼的主要功能。

1. 值操作符、比較操作符、算術操作符、邏輯操作符、位域操作符，如“=”、“+=”、“>=”、“+”、“*”、“%”、“&&”、“||”、“<<”、“^”等二進制操作符前後應當加空格。
2. 一進制操作符“！”、“~”、“++”、“--”、“&”等前後不加空格。
3. 如“[]”、“.”、“->”這類操作符前後不加空格

1. 關于命名的縮寫：

較短的單詞可以通過去掉“元音”形成縮寫；較長的單詞可取單詞頭幾個字母形成縮寫；一些單詞有公認的縮寫，如：

temp 可縮寫為 tmp ;

flag 可縮寫為 flg ;

statistic 可縮寫為 stat ;

increment 可縮寫為 inc ;

message 可縮寫為 msg ;

1. 程式的分界符如“{ }”要獨占一行。如：

for (...)

{

... // program code

}

if (...)

void example_fun( void )

1. if、for、do、while、case、switch、default等語句自占一行，且if、for、do、while等語句的執行語句部分無論多少都要加括号{}。