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>对当前文件中的代码格式化。