C#代碼的規範

身爲一個程序員,如果要想寫出好的程序,就一定要是寫出好的代碼,我們就要明白書寫代碼的規範。爲了統一公司軟件開發的設計過程中關於代碼編寫時的編寫規範和具體開發工作時的編程規範,保證代碼的一致性,便於交流和維護,特制定此規範。

標準註釋

關於代碼註釋我之前的理解一直以爲只是簡單的代碼的註解,然後我發現註釋不僅僅有對代碼註解這一種作用,下面我介紹一下注釋的三種用途:
在模塊、類、屬性、方法前一行添加註釋,以便調用的時候提示用戶
下以方法聲明做例子:
///
///depiction:<對該方法的說明>
///
///<paramname="<參數名稱>"><參數說明>
///
///<對方法返回值的說明,該說明必須明確說明返回的值代表什麼含義>
///
如果模塊只進行部分少量代碼的修改時,則每次修改須添加以下注釋:
///修改人:
///修改日期:
///備份:
/原代碼內容/
將原代碼內容註釋掉,然後添加新代碼使用以下注釋:
///添加人:
///添加日期:
代碼內容
///結束:
對於重構的類文件,需要對原來的類文件做備份,然後放在同級目錄下,在原有文件名
後面添加後綴"_BAK",以便日後版本升級時整理源碼。

命名規則

名字應該能夠標識事物的特性,並且與業務掛鉤。
名字一律使用英文單詞,而不能爲拼音。
名字可以有兩個或三個單詞組成,但不應多於4個,控制在3至30個字母以內。
在名字中,多個單詞用大寫第一個字母(其它字母小寫)來分隔。例如:IsSuperUser。
在具體任務開發中,如果有特定的命名約定,則在相應的軟件開發計劃中予以明確定義
及上報質量管理部審計組。
以下幾點是推薦的命名方法。
Pascal命名法:所有單詞的首字母都大寫,其他字母小寫
Camel命名法:除首字母外,其他單詞的首字母大寫,其他字母小寫
在類屬性的名稱中包含類名是多餘的,如Book.BookTitle。而是應該使用Book.Title。
在變量名中使用互補對,如min/max、begin/end和open/close。
布爾變量名應該包含Is,這意味着Yes/No或True/False值,如fileIsFound。
即使對於可能僅出現在幾個代碼行中的生存期很短的變量,仍然使用有意義的名稱。
僅對於短循環索引使用單字母變量名,如i或j。
文件名要和類名相同,一般情況下一個類一個文件,文件名遵從Pascal命名法,無特
殊情況,擴展名小寫,使用統一而又通用的文件擴展名:C#類.cs。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章