c#和数据库代码文档规范

《c#和数据库代码文档规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、C#代码文档规范11.命名约定1Pascal和Camel命名约定1ADO.NET命名：2界面控件命名：2命名缩写：2推荐的命名方法：32.注释规范4文件头部注释：4函数.属性.类等注释5逻辑点注释53.排版54.代码可读性建议：6后记：7C#代码文档规范我们应该知道规范对于系统的生命周期多么重要，试想如果每个程序员写的程序其他人都难以阅读，最后只能由他本人去维护、修改的话，软件开发将是什么样的噩梦，维护规范的代码和不规范的代码是截然不同的两种体验，所以这里编制代码规范，希望开发人员能够在开发的过程中遵守。1.命名约定对于理解应用程序的逻辑

2、流，命名方案是最有影响力的一种帮助。名称应该说明"什么"而不是"如何"。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用GetNextStudent()，而不是GetNextArrayElement()。Pascal和Camel命名约定编程的命名方式主要有Pascal和Camel两种（Pascal：每个单词的首字母大写，例如ProductType。Camel：首个单词的首字母小写，其余单词的首字母大写，例如productType），各命名应遵守以下规则：标志符规则实例与描述类classPasca

3、lWorksheetCollection枚举类型enumPascalPascal命名委托delegatePascal以Pascal命名，不以任何特殊字符串区别于类名、函数名常量constPascalPascal命名接口interfacePascal例:IDisposable注：总是以I前缀开始，后接Pascal命名方法functionPascal例：ToString()命名空间namespacePascal以.分隔，当每一个限定词均为Pascal命名方式，比如：usingExcelQuicker.Framework参数parameterC

4、amel首字母小写局部变量localvarCamel也可以加入类型标识符，比如对于System.String类型，声明变量是以str开头，stringstrSql=string.Empty;inttype=0;等数据成员datamember—以m开头＋Pascal命名规则，如mProductType（m意味member）属性attributePascalADO.NET命名：类型前缀实例ConnectionconconSQLServer1CommandcmdcmdProductTypeParameterparmparmProductType

5、IDDataAdapterdaddadProductsDataReaderdrdtrProductsDataSetdsdsProductsDataTabledtdtDataRowdrowDataColumncol…DataViewdv…界面控件命名：建议控件在命名时在前面加上控件的类型，最好是加全名，比如buttonQuery，textBoxManufactureDate等，但是如果觉得麻烦可以写成btQuery和tbManufactureDate。这样也有一个缺点，就是不统一，比如对于Label标签控件，有的人用缩写lbl，有的人用la

6、b，有的人用lb……，下面来统一一下控件的命名规则类型前缀实例LabellbllblUserButtonbtnbtnSaveTextBoxtxttxtUserCheckBoxchkchkTypeRadioButtonrbtrbtTypeGroupBoxgrbgrbUserPictureBoxpicbpicbUserComboBoxcombcombUserPanelpanelpanelUserDataGriddgdgUserListBoxlblbTyperCheckedListBoxchklbchklbTypeListViewlvlvUse

7、rTreeViewtvtvUserTabControltctltctlUserDateTimePickerdtpdtpTimeMonthCalendermthcmthcTimeTimetimetimeOneRichTextBoxrtbrtbUserProgressBarprobprobLogonImageListimglimglUserMainMenumenumenuOneContextMenucmenucmenuOneToolBartlbtlbOneStatusBarstabstabOneOpemFileDialogopendlgope

8、ndlgOneSaveFileDialogsavedlgsavedlgOneFolderBrowserDialogfolderdlgfolderdlgOneCrystalReportViewe