.Net开发规范.ppt

目录
数据库命名规范
数据库建表规范
存储过程函数使用规范
代码文件架构
代码逻辑架构
代码命名规范
代码编写规范
数据库命名规范
数据库表名统一采用功能模块大写的四位英文简写编码加下划线加具体表功能名称。示例:UPMS_Application
存储过程统一采用使用p_开头,加上数据库表名或模块简称再加上功能说明表示。示例:p_UPMS_ApplicationAddOne
数据库函数统一采用fn_开头,加上函数名。示例:fn_GetXXX
数据库建表规范
新建数据表必须填写表说明及表字段说明,有外键关系的字段统一不建立实际外键,但是必须在字段说明中描述清晰引用的来源,字典、枚举、状态等字段说明必须描述清晰字典来源或枚举项说明
存储过程函数规范
存储过程或函数必须有清晰明确的注释信息
代码文件架构
代码逻辑架构
命名规范
a)类 【规则1-1】使用Pascal规则命名类名,即首字母要大写。 【规则1-2】使用能够反映类功能的名词或名词短语命名类。 【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。 【规则1-4】自定义异常类应以Exception结尾。 【规则1-5】文件名要能反映类的内容,最好是和类同名。 b) 类字段 【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。 【规则2-2】类字段变量名前可加“_”前缀。 【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。 c)方法 【规则3-1】方法名采用Pascal规则,第一个字符要大写。 【规则3-2】方法名应使用动词或动词短语。 【规则3-3】类中访问修饰符或功能相同的方法应该放在一起, 且公共或实现接口的方法在前。 d)属性 【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写。 【规则4-2】属性和相应字段名称要关联,可以使用“重构”菜单来生成属性。
命名规范
e)参数 【规则5-1】参数采用camel规则命名,且首字符小写。 【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。 【规则5-3】不要给参数加匈牙利语类型表示法的前缀。 【规则5-4】检查方法所有输入参数的有效性。 f)常量 【规则6-1】只读常量使用Pascal命名规则,即首字母大写。 【规则6-2】枚举名使用Pascal规则命名,枚举成员本质属于常量,命名规则同上。 【规则6-3】枚举值从小到大顺序定义。 【规则6-4】静态字段或属性采用Pascal规则,即首字符大写。 g)接口 【规则7-1】接口定义使用Pascal规则,且必须以大写“I”开头。 【规则7-2】接口名称要有意义,中间不要有下划线“_”等字符。 【规则7-3】如果类实现了接口,名称尽量和接口相同,只是省掉“I”字符。
命名规范
h)事件 【规则8-1】委托名称采用Pascal规则,即首字符大写。 【规则8-2】定义事件的委托要使用EventHandler后缀,且包括sender和e两个参数。 【规则8-3】事件用到的参数类,名称要带EventArgs后缀。 i)   C#语言命名空间 【规则9-1】命名空间名称采用Pascal规则,且首字符大写。 【规则9-2】命名空间名称尽量反映其内容所提供的整体功能。 总结: 命名空间,类,事件,接口,常量,属性,方法使用Pascal命名,即首字母大写 参数,变量(类字段)使用camel命名法,即首字母小写。
控件命名规范
Standard Control
Standard Control
Data Control
类型
前缀
示例
AccessDataSource
ads
adsPubs
DataList
dlst
dlstTitles
DetailView
dvw
dvwTitles
FormView
fvw
fvwFonts
GridView
gv
gvCity
ObjectDataSource
ods
odsMenus
Repeater
rpt
rptQueryResults
ReportViewer
rvw
rvwRecord
SiteMapDataSource
smds
smdsSite
SqlDataSource
sds
sdsBooks
XmlDataSource
xds
xdsTitles
类型
前缀
示例
Adrotator
adrt
adrtTopAd
BulletedList
blst
blstCity
Button