C# - 命名規范


規范的編碼提議提高代碼的可讀性,也可以更加高效的進行團隊合作。以下是一些比較好的編碼規范,可供參考:

1.變量定義

 (1)使用string,不使用String;

(2)String.Format()代替字符串拼接;

(3)長字符串相加或拼接次數較多時,使用String.Builder;

(4)使用int.TryParse(),不使用int.Parse();

(5)不再循環內定義變量;

2.命名方法

駝峰式命名方法(Camel-Case),共有兩種方式。

(1)小駝峰命名法

第一個單詞以小寫字母開始,第二個單詞的首寫字母大寫,如:firstName、studentId

(2)大駝峰命名法

每一個單詞的首字母都大寫,也成為Pascal命名法。如:FirstName、StudentId

camel命名法

命名時,單詞之間不以空格、橫杠或者下划線連接,例如不寫成camel、case、camel-case或者camel_case等形式。當然有些編程人員也會使用camel_case這種方式。

3.C#中的命名

命名空間、類名、方法名、使用public修飾的類成員都使用Pascal命名法;

方法的參數、對象實例、控件實例、使用private修飾的類成員及變量使用camel命名。

4.控件命名方法

(1)Button:btn開頭

(2)Textbox:tb開頭

(3)Combox:cb開頭

(4)ContentMenuStrip:cms開頭

(5)ToolStripMenultem:tsmi開頭

(6)CheckBox:ccb開頭

(7)DataGridView:dgv開頭

5.注釋

(1)在每個文件的頭部包含以下注釋說明,如下所示:

//======================================================================
// 文件名:FileName
// 文件功能:FileFunction

//文件編寫者:Author

//文件修改時間:Date
//======================================================================

(2)方法名注釋

在函數中連續輸入三個正斜杠“/”,將出現注釋說明,如下所示:

/// <summary>
/// 編寫方法說明
/// </summary>

///<param name = "參數1">參數說明</param>

///<param name = "參數2">參數說明</param>

(3)單行注釋

//注釋內容

(4)多行注釋

/*

注釋內容

*/

6.使用#region指令折疊代碼

#region 主函數開始位置
static void Main()
{
  Application.EnableVisualStyles();
  Application.SetCompatibleTextRenderingDefault(false);
  Application.Run(new Form1());
}
#endregion

7.縮進

縮進會使代碼邏輯更加清晰,嵌套更加明確。縮進時不要是使用空格鍵,使tab鍵。

8.格式化代碼

VS中可使用快捷鍵<Ctrl + E>,再按下組合鍵<Ctrl + D>對當前文件中的代碼格式化。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM