文档介绍：程序规范
命名中使用英文名称,杜绝使用拼音、英文首字母组合。
命名空间、类命名定义采用英文首字母大写,如:UserInfo,接口采用:IUser
页面空间命名使用开头3字母前缀。详细见附表:
私有变量、局部变量采用首字母小写,后面的单词首字母大写,如:userName
公共变量及属性采用单词首字母大写,如:UserName
方法名称统一使用单词首字母大写,并使用动名词形式,如:SetUserName。方法中的参数采用私有变量的命名方式。
if、while、for、foreach等语句即使后面只有一句逻辑,也要使用大括号。
大括号“{”、“}”放在单独的行中。
.cs文件开头需使用注释说明建立者,建立日期等注释。
// ==========================================
// Author:<AuthorName>
// Create date: <Create Date>
// Description: <Description>
// ==========================================
类、方法、属性注释,采用标准注释。即连续打三个“/”开发环境自动生成注释框架。
除非在类构造函数中(用于区别构造函数参数与类私有变量),否则避免使用this关键字引用类的私有变量。
常量命名全部使用大写单词,单词之间使用下划线“_”连接。
修饰符,如:public、protected、private等,在限定类或者方法的时候最小化作用范围。
在引用命名空间的时候,系统命名空间在上,自定义命名空间在下。系统和自定义命名空间之间留空行。
在引用类、函数、变量时不能使用完全限定名,必须引用命名空间后使用。(继承Page除外)
方法之间必须有空行隔开。
语句缩进,应使用TAB进行缩进,设置开发环境一个TAB显示宽度等于4个空格宽度。
程序行之间采用逻辑块之间增加空行,每行之间没有空行与都有空行会降低程序可读性。
页面文件命名采用单词首字母大写,如::
。
数据新增页面使用类似:。
数据编辑页面使用类似:。
统计界面使用类似:。
详细数据浏览使用类似:。
综合查询功能页面使用类似:。
多语言化页面要在App_GlobalResources、App_LocalResources文件夹下面对应相应的文件名建立文本文件,如:,此文件描述需要多语言化的内容。
注:英文全称存在简写的,可使用简写。如:Information可使用Info,Statistic可使用Stat。表示状态的Status使用全称。
尽量使用英文中原有的简写,不要自创简写。
更多请参见附录:
数据库规范
数据库表、视图、存储过程命名按照如下格式:
表:T_User,视图V_User,存储过程P_UserList,主键PK_UserId,外键FK_外键表名_外键字段名,索引IX_LoginId。
规则为开头简写大写字母加下划线加全称英文单词,英文单词首字母大写。
数据库语句中SQL关键字,系统默认参数、变量全部大写,数据类型除外,如:nvarchar(50)。
数据库存储过程参数采用@+英文全称的命名方式,如:***@UserId,英文单词首字母大写。
多表交叉查询语句不使用表别名,使用完整的限定名。
查询语句中的字段大小写于数据表设计时使用的大小写一样。
语句缩进,应使用TAB进行缩进,设置开发环境一个TAB显示宽度等于4个空格宽度。
不应在任何Sql语句中使用SELECT * FROM …,必须使用完整的列名称。
代码中使用BEGIN END语句块,并缩进,提高可读性。
存储过程事务规则:
在没有特殊需要自己控制回滚的情况下建议采用:
SET XACT_ABORT ON
BEGIN TRANSACTION
这里是多表操作逻辑
COMMIT TRANSACTION
存储过程标准注释参考:
-- =============================================
-- Author: <Author,,Name>
-- Create date: <Create Date,,>
-- Description: <Description,,>
-- ====================