C 編碼規範

c#編碼規範

規範的制定原則：

1 參照微軟在vs.net中，c#既有的規範來制定 2

方便**的交流和維護。 3

不影響編碼的效率，不與大眾習慣衝突。 4

使**更美觀、閱讀更方便。 5

使**的邏輯更清晰、更易於理解。

規範的遵守原則：

1 如果是軟體外包專案，並且對方制定了**的編寫規範，則首先要遵守對方的編碼規範。如果對方沒有明確指定**的編碼規範，則需要遵守本公司自己的編碼規範。 2

本公司的編碼規範分為兩部分，第一部分是必須遵守的部分，第二部分是建議遵守的部分。一般情況下，兩部分都要遵守，但在專案進度非常緊張的情況下，第二部分可以適當放寬。

術語定義：

pascal

大小寫

backcolor

camel

大小寫識別符號的首字母小寫，而每個後面連線的單詞的首字母都大寫。例如：

backcolor

第一部分：必須遵守的部分

l 檔案/類的命名規則 l

方法的命名規則 l

常量、變數、引數的定義規則 l

**的格式 l

注釋的書寫格式 l

效率方面注意的問題

檔案的命名規則：

檔案的命名採用pascal命名規則，無特殊情況，檔案的副檔名小寫。

檔案的副檔名使用統一而且通用的副檔名，如c#類使用副檔名：.cs

例如：studentinfo.cs

department.cs

類的命名規則：

類的名字必須是有意義的，且與類實現的功能或業務邏輯相關的名字。

除介面類的其他所有類（包括普通類、抽象類等）都採用pascal命名法，且主類的名字與檔名一致。

介面類有自己特殊的命名規則：類的字首為「i」,後面連線pascal命名法所起的有意義的名字。同樣，類名與檔名相同，如：iformatable。

方法的命名規則：

按照c#語言本身的原始特徵，方法的命名採用pascal命名規則。另外，方法的命名應該說明的是「什麼」，而不是「如何」；方法的名稱應該足夠長以便有一定的意義，又應該足夠短，以避免冗長。如：

writetofile()。

常量所有的常量都必須是大寫字母組成，如果常量有幾個單詞組成，則單詞之間用下劃線「_」進行連線，如：

private const string user_name = 「abc」; 變數

變數在定義的時候，需要根據變數的資料型別新增不同的字首(字首全部小寫)，但不需要區分其作用域。另外，變數的命名規則採用pascal命名規範。如：

private string strname = 「」;

另外，c#中各常用的變數的字首如下表所示： 型別

含義 縮寫

舉例bool

真/假 is

isoverflow

byte 8

位無符號整數型別

bytbytcount

char

字元型別

chrchrflag

decimal

金融計算所用的數字型別

decdecamount

double

雙精度浮點型別

dbldblamount

float

單精度浮點型別

fltfltamount

int 整形

intintcount

long

長整形lng

lngweight

sbyte 8

位有符號整數

sbtsbtcount

short

短整形sht

shtamount

string

字元型str

strname

uint

無符號整型

uituitcount

ulong

無符號長整形

ulgulgcount

ushort

無符號短整形

ustustcount

引數在方法定義中的形參，採用pascal命名方法，不需要根據資料型別來新增字首，作為呼叫方法時傳遞的實參，則採用上面變數的命名規則，使用資料型別字首+pascal命名方法。 如：

void setname(string name)

呼叫的時候，可以如下：

string strname = 「abc」;

setname(strname);

**的格式

**的格式包括縮排、換行、空行、空格等，為了不影響編碼的效率，在此只作如下規定：

（1）、空格、空行不做嚴格的固定，以使**清晰為基本原則。空行不影響程式的執行，但可以使**看起來清晰，增加可讀性，因此可以適當的多用。

（2）、**的縮排建議使用tab鍵進行控制，tab鍵的大小設定為4個空格。每個層次都要進行縮排。

（3）、換行，掌握的原則是不要使一行**特別的長，再不產生嚴重歧義或增加閱讀難度的情況下，盡量控制在120列之內，以方便**的列印。另外，換行的原則是，在逗號後，操作符前換行，換行與首行要保持乙個單位的縮排。

例如：string strsql = 「select id,name,***,birthday,」

+ 「belongclassid,belonggradeid 「

+ 「from studentinfo」;

（4）、必須單獨在一行上，且上下對齊。

（5）、if，while，do，try-catch-finally等語句後必須有{},即使裡面只有一條語句或為空，且遵循單獨成行的原則。 注釋

要養成良好的**注釋習慣，通常，注釋要佔實際**總行數的1/3，同時，要在編寫**前或編寫**的同時進行**的注釋，不要事後補寫注釋。

注釋分為多行注釋和單行注釋，我們的原則是：在類和方法的前面，要寫多行注釋，在定義類的全域性變數/常量，以及方法的內部，使用單行注釋。注釋的前面與**之間要有空行。

即使是單行注釋，我們鼓勵都要單獨一行，不鼓勵在語句的後面使用注釋，當然，在變數定義的後面使用注釋也是允許的，但不建議這麼做。

另外，在編寫注釋的時候，建議使用c#自己的注釋風格，即在類的前面和方法的前面使用「///」進行注釋。

另外，注釋還包括多人修改同乙個檔案時如何注釋，版本發行後如何注釋等。具體看對應的source。

例如：特別注意，如果是在已經發行版本的基礎上新增、修改、刪除**，則需要將原先的**注釋掉，而不是直接刪除掉，然後新增自己的**。如：

新增新**的注釋：

//add by [

姓名] yyyymmdd ®

*** //¬

add by [

姓名] yyyymmdd

修改**的注釋：

//update by [

姓名] yyyymmdd ®

// ***

yyy //

¬update by [

姓名] yyyymmdd

刪除**的注釋：

//delete by [

姓名] yyyymmdd ®

//*** //

¬delete by [

姓名] yyyymmdd 宣告

每行只定義乙個宣告，多個宣告要分多行來定義。

例如：int intage,intweight;       //

不推薦

應使用如下的定義形式：

int intage;

int intweight;

宣告的位置：

變數要在塊的開始的地方集中進行宣告，不要何時用到何時臨時定義。（臨時變數除外如控制迴圈變數等）

第二部分：建議遵守的部分

本部分在編寫的過程中，可能對於新手來說，會降低編碼的效率，但遵守本部分規範會使**的美觀性和易讀易維護性得到提高，因此，在專案進度不是很緊張的情況下，建議遵守。

C 編碼規範

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

C 編碼規範

一 型別級單位的命名 1 類。以class 宣告的類，都必須以名詞或名詞短語命名，體現類的作用。如 class indicator 當類是乙個特性 attribute 時，以 attribute 結尾，當類是乙個異常 exception 時，以 exception 結尾 class colorset...

c 編碼規範

編碼規範是乙個很大的問題！之前我的c語言編碼規範是按著大學養成的習慣來的，可是滿足不了工作的需求，現在就仿著華為的編碼規範來吧。不過其中的函式名的命名規則，華為的是按駝峰命名規則，但是自己覺得彆扭，現在公司要求不嚴，那就按qt的命名規則來吧，小寫，中間下劃線，這樣看著爽。至於別的，自己慢慢補充！1 ...