C 程式編碼規範

2021-09-30 02:59:02 字數 2334 閱讀 5246

1.       目的

為了保證企業編寫出的程式都符合相同的規範,保證一致性、統一性而建立的程式編碼規範。

2.       範圍

適用於企業所有基於.net平台的軟體開發工作。

3.       規範內容

3.1.    **格式

u       所有的縮排為4個空格,使用vs.net的預設設定。

u       在**中垂直對齊左括號和右括號。

if(x==0)

不允許以下情況:

if(x==0)

或者:if(x==0)

u       當一行被分為幾行時,通過將串聯運算子放在每一行的末尾而不是開頭,清楚地表示沒有後面的行是不完整的。

u       每一行上放置的語句避免超過一條。

u       在大多數運算子之前和之後使用空格,這樣做時不會改變**的意圖卻可以使**容易閱讀。

例:int j = i + k;

而不應寫為

int j=i+k;

u       將大的複雜**節分為較小的、易於理解的模組。

u       編寫 sql 語句時,對於關鍵字使用全部大寫,對於資料庫元素(如表、列和檢視)使用大小寫混合。

from customers

where state = 'wa'

3.2.    注釋(comment)規範

注釋規範包括:模組(類)注釋規範、類的屬性、方法注釋規範、**間注釋

3.2.1. 模組(類)注釋規範

模組開始必須以以下形式書寫模組注釋:

//////模組編號:《模組編號,可以引用系統設計中的模組編號》

///作用:《對此類的描述,可以引用系統設計中的描述》

///編寫日期:《模組建立日期,格式:yyyy-mm-dd>

///如果模組有修改,則每次修改必須新增以下注釋:

//////log編號:

/ 類屬性注釋規範

在類的屬性必須以以下格式編寫屬性注釋:

///

///屬性說明

///

3.2.3. 方法注釋規範

在類的方法宣告前必須以以下格式編寫注釋

///

/// 說明:《對該方法的說明》

///

/// 《引數說明》

///

///《對方法返回值的說明,該說明必須明確說明返回的值代表什麼含義》

///

3.2.4. **間注釋規範

**間注釋分為單行注釋和多行注釋:

單行注釋:

//《單行注釋》

多行注釋:

/*多行注釋1

多行注釋2

多行注釋3*/

**中遇到語句塊時必須新增注釋(if,for,foreach,……),新增的注釋必須能夠說明此語句塊的作用和實現手段(所用演算法等等)。

3.3.    變數(variable)命名規範

3.3.1. 程式檔案(*.cs)中的變數命名規則       

程式中變數名稱 = 變數的字首 +代表變數含意的英文單詞或單詞縮寫。

1.  類模組級的變數請用「m_」作字首

public class hello

2.  類的屬性所對應的變數,採用屬性名前加「m_」字首的形式

public class hello}}

3.  過程級的變數不使用字首

public class hello

}4.  過程的引數使用「p_」作為引數

public class hello

}補充說明:

針對異常捕獲過程中的exception變數命名,在沒有衝突的情況下,統一命名為e;

如果有衝突的情況下,可以重複e,比如:ee。

trycatch(exception ee)

}catch(exception e)

補充:如果捕獲異常不需要作任何處理,則不需要定義exception例項

例:try

catch( exception )

5.  鑑於大多數名稱都是通過連線若干單詞構造的,請使用大小寫混合的格式以簡化它們的閱讀。每個單詞的第乙個字母都是大寫.

6.  即使對於可能僅出現在幾個**行中的生存期很短的變數,仍然使用有意義的名稱。僅對於短迴圈索引使用單字母變數名,如 i 或 j。

7.  在變數名中使用互補對,如 min/max、begin/end 和 open/close。

8.  不要使用原義數字或原義字串,如 for i = 1 to 7。而是使用命名常數,如 for i = 1 to num_days_in_week 以便於維護和理解。

3.3.2. 控制項命名規則

控制項命名=web控制項縮寫字首  + 「_」 +變數名

C 程式編碼規範

c 程式編碼規範 選擇自 wirte 的 blog 關鍵字 c 編碼規範 出處1.目的 為了保證企業編寫出的程式都符合相同的規範,保證一致性 統一性而建立的程式編碼規範。2.範圍 適用於企業所有基於.net平台的軟體開發工作。3.規範內容 3.1.格式 u所有的縮排為4個空格,使用vs.net的預設...

C 編碼規範

c 編碼規範 規範的制定原則 1 參照微軟在vs.net中,c 既有的規範來制定 2 方便 的交流和維護。3 不影響編碼的效率,不與大眾習慣衝突。4 使 更美觀 閱讀更方便。5 使 的邏輯更清晰 更易於理解。規範的遵守原則 1 如果是軟體外包專案,並且對方制定了 的編寫規範,則首先要遵守對方的編碼規...

C 編碼規範

c 編碼規範 1.目的 為了保證企業編寫出的程式都符合相同的規範,保證一致性 統一性而建立的程式編碼規範。2.範圍 適用於企業所有基於.平台的軟體開發工作。3.規範內容 3.1.格式 u 所有的縮排為4個空格,使用vs.的預設設定。u 在 中垂直對齊左括號和右括號。if x 0 不允許以下情況 if...