1.**命名要規範。最好為英文。
方法命名:首字母大寫。比如testname。變數或者引數命名,首字母小寫,如:firstname
如下圖。類的命名、方法、屬性的命名首字母大寫。變數、字段、引數(沒有成員的)首字母小寫。屬性不是字段,是類的成員-------方法。類成員包括:字段、屬性、方法。屬性是一種特殊的方法。
2.括號對稱,方法體花括號、if、else、等方法體花括號,對齊對稱,內嵌錯落有致。
第二個括號寫上注釋,//表明是屬於哪個開始括號的方法體括號。特別是複雜巢狀時:如下圖:
3.注釋
乙個簡潔、易於理解的注釋能夠起到很大的幫助,不論對於維護人員、開發人員等等。
注釋的要求:
注釋應該避免在**行的末尾進行新增,不過進行單行或者變數等其他宣告時,行尾注釋是合適的。
注釋應該是對齊美觀的,不應該雜亂。
若是對**有所修改,注釋也應當進行更新,以免給下次看到此處**的人造成誤判。
最好在編寫**時就給上注釋,因為日後可能沒有時間回過頭來進行新增。
文件型注釋:
在宣告介面、類、方法、屬性、欄位都應該使用這種方法的注釋,以便**完成後直接生成**文件,讓別人更好的了解**的實現和介面。如:
類、介面注釋:
方法、事件的注釋:
當然也不是所有的方法或者類,都需要非常非常詳細的注釋,這一點盡量根據實際需要來進行注釋,簡單的類或者方法就完全沒用必要進行注釋了,但是在實際開發當中,同名、類似、功能相似、可能會給人帶來迷惑,而有的方法邏輯有時候也是非常複雜,這個時候就很有必要進行注釋的批註了。
屬性、常量注釋://屬性首字母大寫。字段、引數、變數等沒有包含成員的命名首字母小寫。
4.宣告
欄位的宣告:不要使用public或者protected的例項字段。如果避免將字段直接公開給開發人員,可以更輕鬆地對類進行版本控制。
5.命名
命名應該說明「什麼」而不是「如何」。如可使用getnextstudent(),而不是getnextarrayelement()
大小寫規則
pascal 首字母大學。camel:首字母小寫
型別 class :pascal eg:streamreader
介面 inte***ce :pascal eg:ienumerable
方法 :pascal eg:tostring()
屬性:pascal eg:public int length //唯讀屬性
事件 :pascal eg:public event eventhandler exited;
字段(私有字段)camel eg:private string username;
字段(公共靜態)pascal eg:public static readonly string userid;
引數:camel eg:public static int toint32(string userid);
類
使用pascal大小寫。
用名詞或名詞短語命名類
使用全稱避免縮寫,除非是公認的約定,比如:url 、html
不應使用型別字首,如在類名稱上對型別使用c,比如filestream而不是cfilestream
不應該使用下劃線_
有時候需要提供以字母 i 開始的類名稱,就算該類並不是介面。比如類名稱identitystore是可以的。
介面
使用名詞或者名詞短語,命名介面。
使用pascal大小寫。
盡量少用縮寫。
給介面名稱加上字母 i 字首,以指示該型別為介面。在定義類/介面對(其中類是介面的標準實現)時使用類似的名稱。兩個名稱的區別應該只是介面名稱上有字母i字首。比如:iservice和service
不應使用下劃線_
列舉
使用pascal大小寫。如 public enum datastatus{}
少用縮寫
不要在 enum 型別名稱上使用 enum 字尾
引數
引數名稱使用camel大小寫
使用描述性引數名稱
正確命名如下:
type gettype(string typename)
方法
使用動詞或動詞短語命名
使用pascal
正確例項如下:
removeall()
getchararray()
invoke()
屬性(property)
使用名詞或名詞短語
使用pascal大小寫
常量(const)
所有單詞大寫,多個單詞之間用 "_" 隔開。 如
public const string page_title = "welcome";
字段
private、protected使用camel大小寫
public使用pascal大小寫
僅在開發人員一般都能理解時使用縮寫。欄位名稱不要使用大寫字母。正確例項如下:
對預定義物件例項使用公共靜態唯讀字段。如果存在物件的預定義例項,則將它們宣告為
物件本身的公共靜態唯讀字段。使用 pascal 大小寫,原因是字段是公共的。如:
public static readonly color red = new color(0x0000ff);
集合
集合是一組組合在一起的類似的型別化物件,如雜湊表、查詢、堆疊、字典和列表,集合的命名
建議用複數。
C 編碼規範和程式設計好習慣
c 編碼規範和程式設計好習慣 撰文 dotnetspider.com 誰都會寫 幾個月的程式設計經驗可以讓你寫出 可執行應用程式 讓它可執行容易,但是以最有效率的方式編碼就需要下更多的功夫!要知道,大多數程式設計師在寫 可執行 而不是 高效 我們在這個指南課程前面提到,你想成為你們公司 最尊貴的專業...
C 編碼規範和程式設計好習慣
c 編碼規範和程式設計好習慣 撰文 dotnetspider.com 翻譯 楊賀巨集 誰都會寫 幾個月的程式設計經驗可以讓你寫出 可執行應用程式 讓它可執行容易,但是以最有效率的方式編碼就需要下更多的功夫!要知道,大多數程式設計師在寫 可執行 而不是 高效 我們在這個指南課程前面提到,你想成為你們公...
C 編碼規範2 良好的程式設計習慣
詞語選擇 避免使用由經常使用的命名空間複製的型別名。型別名不能使用下列詞語。system collections forms ui 識別符號 包括引數名 中不要使用縮寫。如果必須使用縮寫 任何超過兩個字元以上的縮寫都使用camel大寫格式,即使這不是標準縮寫。命名空間 命名命名空間的一般規則如下 c...