C#编码规C# Programming Conventions).docVIP

C#语言代码书写规范 变量命名 对于各个基本类型的变量，在命名时，参考如下例子： 变量类型 前缀规则 举例 说明 string s sEmployeeName int i iAge 用于循环的i,j,k等除外 long l lTotalMoney bool b bIsMember float f fFloatData double d dDoubleData byte by byByteData 私有字段命名 变量类型 前缀规则 举例 说明 string _s sEmployeeName int _i iAge 用于循环的i,j,k等除外 long _l lTotalMoney bool _b bIsMember float _f fFloatData double _d dDoubleData byte _by byByteData 组件以及集合（Assemblies）命名规则 我公司开发的代码库(在 .NET 中称为assembly)命名规则： 以公司名称公司（Vanceinfo）作为第一级，例如：在开发一个用于扩充C# database 类的, 名字命名.DatabaseOperation 方法（method）的命名规则 1．方法命名使用英文单词组合，每个单词首字母大写。 2．在名称过长时，可以使用英文单词的缩写。 3．组成方法的单词顺序，动词一般放在前面，名词放在后面。 4．写法举例： AddData(…) AppendEmployee(…) 5．以下写法不正确： Add_Data(…) DataAdd(…) 名称空间与类的命名规则 1．类命名使用英文单词组合，每个单词首字母大写。如：StringIntObject 2．在名称过长时，可以使用英文单词的缩写。 3．名称空间（NameSpace）的命名规则与类的相同。 4．名称空间的命名规则如下： Vanceinfo.项目代码.第一层功能划分.第二层功能划分.**** 例如： Vanceinfo.Patent.Management.CustomerManager 对象的命名规则 1．在new一个新的对象时或者使用类的原名称，但第一个字母小写；此规则适合于类内的全局变量； 例如：HelloWorld helloWorld = new HelloWorld()； 或者前缀使用类的小写字母的缩写，然后使用英文单词组合，适合于一个方法内的局部变量； 例如：HelloWorld hwGreeting = new HelloWorld(); 2．如果对象是包含很多数据的集合等，名称中要用英文单词复数。 例如：DataSet dsCustomers = new DataSet(); 3．在Form中的控件对象的命名要求使用以下前缀： 控件名称 命名规则 举例 说明 Label lb lbUserName TextBox tb tbPassword ComboBox cmb cmbFavority DropDownList ddl ddlDepartment ListBox lst lstOrders Button btn btnSubmit CheckBox chk chkHaveOne RadioButton rb rbSoftware ListView lv lvEmployee TreeView tv tvFileFolder GroupBox gb gbCustomerDetail DateTimePicker dtp dtpEditDate DataGrid dg dgCustomers Menu mnu mnuSetTitle MenuItem mnuItem mnuItemSave ……可继续补充新的控件 4．如果控件对象是包含很多数据的集合等，名称中要用英文单词复数。 例如：ListBox对象，由于存放订单数据，则命名为 lbOrders 文件划分与命名规则 1．文件划分： 一般要求一个Class作为一个文件。 如：名称空间Vanceinfo.Patent.Management.CoustomerManager 划分为三个文件： WebVendorManager.aspx // 界面层 VendorManager.aspx // 逻辑层 Credit.aspx // 服务商信用等级类 2．文件的命名： 文件中类的名称作为文件的名称，大小写要完全对应。例子如上。 注释的书写 1．文件头注释： 严格按照如下的风格书写： //-------------------