C 的命名規範 2

2021-05-27 00:38:09 字數 2202 閱讀 2260

1、命名約定

pascal和camel命名約定

程式設計的命名方式主要有pascal和camel兩種(pascal(帕斯卡):每個單詞的首字母大寫,例如producttype;camel(駱駝峰):首個單詞的首字母小寫,其餘單詞的首字母大寫,例如producttype)

命名縮寫

在一般情況下,不推薦縮寫命名,不要擔心變數命名長,長的變數名能使變數的意義更加清晰,其實從長變數名的負面作用三,因為ctrl+c和ctrl+v加上在vs中的智慧型感知,其負面追用已經很小。變數命名的原則是,盡最大努力讓其他人在看到我們的變數/函式/…等的第一時間,大概能猜出它是做什麼的。

比如:int producttypecount = 0; //我們在第一時間就能知道它是記錄產品的數量的變數

而對於糟糕的命名方式:int prodtypecount = 0; //它是producttypecount的簡寫,我們一部分人也許知道prod是product的縮寫,但是每人能保證所有的人都知道它。我個人認為:最優秀的**它本身就是注釋。作為一流的程式設計師。並不僅僅實現功能,而是要讓我們的**更加優美,具備讓他人維護或今後擴充的能力。作為現在的業務系統,其門檻的准入水平已大大降低,實現功能上的需求已沒有什麼難度,但是高手和菜鳥的區別在於,高手的**通俗易懂,在整個編碼的過程中,不僅能考慮到效能、還會考慮**可讀性和維護性。

資料庫命名

資料庫的字段、表名的命名都推薦採用pascal命名方式,盡量不採用縮寫。當然,使用長的欄位名、表名,可能會使sql語句的編寫帶來負面影響。我推薦大家可以使用一些orm,orm的效能肯定不會比直接寫sql的好,但是如果做業務系統,更重要的是系統多久能交付使用者使用,orm不僅使開發時間可以縮短不少,並且在後期的維護上也比直接寫sql便利很多。

檔案頭部注釋

在**檔案的頭部進行注釋,這樣做的好處在於,我們能對**檔案做變更跟蹤。在**頭部分標註出創始人、創始時間、修改人、修改時間、**的功能,這在團隊開發中必不可少,它們可以使後來維護/修改的同伴在遇到問題時,在第一時間知道他應該向誰去尋求幫助,並且知道這個檔案經歷了多少次迭代、經歷了多少個程式設計師的開發和修改。

樣本:** 修改人:lucy

** 修改人:lucy

** 描述:

**    主要用於產品資訊的資料錄入,…

函式、屬性、類等注釋

請使用///三斜線注釋,這種注釋是基於xml的,不僅能匯出xml製作幫助文件,而且在各個函式、屬性、類等的使用中,編輯環境會自動帶出注釋,方便你的開發。以protected,protected internal,public宣告的定義注釋都建議以這樣命名方法。

例如:///

/// 用於從erp系統中撈出產品資訊的類

///

class producttypecollector

邏輯點注釋

在我們認為邏輯性較強的地方加入注釋,說明這段程式的邏輯是怎樣的,以方便我們自己後來的理解以及其他人的理解,並且這樣還可以在一定程度上排除bug。在注釋中寫明我們的邏輯思想,對照程式,判斷程式是否符合我們的初衷,如果不是,則我們應該仔細思考耀修改的是注釋還是程式了…

介面控制項命名

我的建議是使用預設控制項名作為字首,字首名稱全部小寫,這樣的好處是不必為未知的控制項統一命名方式發愁,比如對於label標籤控制項,有的人用縮寫lbl,有的人用lab,有的人用lb。這樣其實仍然是避免使用縮寫,有的時候仍然會使命名變得冗長,但是命名更加能反應出變數的意義,並且各個開發人員也能更好的執行,因為他們不需要去背記各個變數的縮寫。

protected system.web.ui.webcontrols.button buttonquery;

protected system.web.ui.webcontrols.dropdownlist dropdownlistproducttype;

protected system.web.ui.webcontrols.textbox textboxmanufacturedate;

在介面層中盡量使用異常處理try語句,不要將系統級別的錯誤直接暴露給使用者,而更應該的是把系統丟擲的錯誤資訊記錄到log日誌檔案中去,告訴使用者友好的提示資訊

在visual studio 裡面,有**布局格式化功能,蠻有用的。其實**的規範是為了使系統具有整體一致的編碼風格,以使後期維護人員能更快的讀懂**並進行維護。我認為**規範有其必要性,但不能因為規範而規範,從開發而言,開發是為了更快的做出穩定的系統,而穩定的系統是為了給公司帶來受益。開發人員、專案管理人員都應該更多的從專案經營的角度出來,同時站在公司、客戶的角度考慮問題,而不是因為**而**。

C 編碼規範 2 命名規範

如果你 中的變數名,函式數,類名都取得很好,不僅是個有意義的詞或短語,而且確切的表達了該變數或函式的功能.那讀起 來就像看文章一樣,絕對是一種享受.當然理想是美好的,現實可是殘酷的.很少有人能做到這樣.一來嘛你英語詞彙量得多,不樣不容易找到那麼多合適並貼切的詞.二來就是有些詞組合就會很長,這樣不得不...

命名規範 C 命名規範約定

命名規則約定 序 號描述示例 1類命名混合使用大小寫,首字母大寫 classname 2型別定義,包括列舉和typedef,混合使用大小寫,首字母大寫 typename 3區域性變數混合使用大小寫,且首字母小寫,名字與底層資料型別無關,且應該反映其所代表的事物 localvariable 4子程式引...

C 的命名規範

本文從類 類欄位 方法屬性 引數常量 介面 事件 命名空間等9個方面總結了c 語言命名的規則。下面介紹c 語言命名的9種規範 a 類 規則1 1 使用pascal規則命名類名,即首字母要大寫。規則1 2 使用能夠反映類功能的名詞或名詞短語命名類。規則1 3 不要使用 i c 等特定含義字首。規則1 ...