C编码规范C Programming Conventions.doc

《C编码规范C Programming Conventions.doc》由会员分享，可在线阅读，更多相关《C编码规范C Programming Conventions.doc（5页珍藏版）》请在三一办公上搜索。

1、C#语言代码书写规范一 变量命名对于各个基本类型的变量，在命名时，参考如下例子：变量类型前缀规则举例说明stringssEmployeeNameintiiAge用于循环的i,j,k等除外longllTotalMoneyboolbbIsMemberfloatffFloatDatadoubleddDoubleDatabytebybyByteData私有字段命名变量类型前缀规则举例说明string_ssEmployeeNameint_iiAge用于循环的i,j,k等除外long_llTotalMoneybool_bbIsMemberfloat_ffFloatDatadouble_ddDoubleDa

2、tabyte_bybyByteData二 组件以及集合（Assemblies）命名规则我公司开发的代码库(在 .NET 中称为assembly)命名规则：以公司名称公司（Vanceinfo）作为第一级，例如：在开发一个用于扩充C# database 类的库, 名字命名应该为：Vanceinfo.DatabaseOperation三 方法（method）的命名规则1方法命名使用英文单词组合，每个单词首字母大写。2在名称过长时，可以使用英文单词的缩写。3组成方法的单词顺序，动词一般放在前面，名词放在后面。4写法举例：AddData()AppendEmployee()5以下写法不正确：Add_Dat

3、a()DataAdd()四 名称空间与类的命名规则1类命名使用英文单词组合，每个单词首字母大写。如：StringIntObject2在名称过长时，可以使用英文单词的缩写。3名称空间（NameSpace）的命名规则与类的相同。4名称空间的命名规则如下：Vanceinfo.项目代码.第一层功能划分.第二层功能划分.*例如：Vanceinfo.Patent.Management.CustomerManager五 对象的命名规则1在new一个新的对象时或者使用类的原名称，但第一个字母小写；此规则适合于类内的全局变量；例如：HelloWorld helloWorld = new HelloWorld()

4、； 或者前缀使用类的小写字母的缩写，然后使用英文单词组合，适合于一个方法内的局部变量；例如：HelloWorld hwGreeting = new HelloWorld(); 2如果对象是包含很多数据的集合等，名称中要用英文单词复数。例如：DataSet dsCustomers = new DataSet();3在Form中的控件对象的命名要求使用以下前缀：控件名称命名规则举例说明LabellblbUserNameTextBoxtbtbPasswordComboBoxcmbcmbFavorityDropDownListddlddlDepartmentListBoxlstlstOrdersBut

5、tonbtnbtnSubmitCheckBoxchkchkHaveOneRadioButtonrbrbSoftwareListViewlvlvEmployeeTreeViewtvtvFileFolderGroupBoxgbgbCustomerDetailDateTimePickerdtpdtpEditDateDataGriddgdgCustomersMenumnumnuSetTitleMenuItemmnuItemmnuItemSave 可继续补充新的控件4如果控件对象是包含很多数据的集合等，名称中要用英文单词复数。例如：ListBox对象，由于存放订单数据，则命名为 lbOrders六 文件

6、划分与命名规则1文件划分：一般要求一个Class作为一个文件。如：名称空间Vanceinfo.Patent.Management.CoustomerManager划分为三个文件：WebVendorManager.aspx / 界面层VendorManager.aspx / 逻辑层Credit.aspx / 服务商信用等级类2文件的命名：文件中类的名称作为文件的名称，大小写要完全对应。例子如上。七 注释的书写1文件头注释：严格按照如下的风格书写：/-/ / Copyright(c) 文思创新软件技术有限公司. / /-/*/* FileName: WebMain.aspx */* Functio

7、n: “登录”软件主界面 */* Author: 张三 */* Date: 2006-07-24 */* Modified: 李四（2007-08-23） */*/其中的日期，要求按照YYYY-MM-DD的格式书写。2文件中的注释：。要求全部使用中文书写注释；。变量的注释写在变量的同一行变量的后面，格式如下：bool bHasChanges = false; / 记录在数据是否改变。对象的注释写在对象的上一行，格式如下：/ 客户数据的数据集DataSet customerDataSet = new DataSet();。方法的说明注释写在方法的紧上面，使用如下的格式：(1).自定义函数的注释格

8、式/#/ / 保存数据/ Author: 张三（2006-07-24）/ / 要报存的数据所存放的DataSet/ 返回保存是否成功的标记，成功：true；失败：False/#Public bool SaveData(DataSet ds)(2).系统产生的函数的注释格式/=/ / 窗体加载事件响应函数/ Author: 张三（2007-08-23）/ /=Public void FormLoad()。程序块的注释写在相应程序块的前面；一个完整的程序块一般不要使用空行；。一个完整的程序块，其前一行和后一行，分别使用空注释行，即使用“/”开始，后面不跟任何字符；对其说明的注释写在块的紧上面一行，

9、格式如下：/ 计算本年度利润bFinish = false;sDept = “Welcome to China”;./。版本升级时代码修改的注释，要求对于要修改的代码，注释说明。格式如下：/ 版本升级及bugzilla仅供参考/ 计算本年度利润/ 改动开始：, , / ./ 改动结束：/八 程序的书写1缩进书写严格按照四字符缩进；2循环书写参照下例：for(i=0; i100; i+)iANum = iANum +；说明：单行的循环块也必须使用。3If语句嵌套最多不允许超过三层；4函数和函数之间空一行；5不允许多行不必要的空行；6每个自定义函数必须标明作者；7在对一个函数进行重大修改时，在修改处必须标明作者、修改日期和修改内容；8要尽量避免建立过于庞大的类；尽量避免建立过于庞大的函数；9全局变量必须在类的构造函数之前进行定义。