Net综合项目代码编写标准规范.doc

目录
1. C# 代码风格规定 3
1.1注释 3
1.2 类型（类、构造、委托、接口）、字段、属性、办法、事件命名 3
1.3 不使用缩写 4
1.4 代码使用半展开 4
1.5 使用Tab作为缩进，并设立缩进大小为4 5
1.6 一种.cs源文献至多定义两个类型 7
1.7 类型名称和源文献名称必要一致 7
1.8 所有命名空间、类型名称使用Pascal风格（单词首字母大写） 7
1.9 本地变量、办法参数名称使用Camel风格（首字母小写，其后每个单词首字母大写） 7
1.10 私有办法、受保护办法，仍使用Pascal风格命名 8
1.11 如果if语句内容只有一行，可以不加花括号，但是必要和if语句位于同一行 8
1.12 调用类型内部其她成员，需加this；调用父类成员，需加base 9
1.13 类型内部私有和受保护字段，使用Camel风格命名，但加“_”前缀 9
1.14 不能浮现公有字段 10
1.15 类型成员排列顺序 10
1.16 委托和事件命名 11
1.17 返回bool类型办法、属性命名 11
1.18 常用集合类型后缀命名 12
1.19 常用后缀命名 12
1.20 常用类型命名 13
1.21 常用字段、属性命名 14
2. XHTML 代码风格规定 14
2.1 如果XHTML标记有层次，那么代码也要有层次 14
2.2 所有标记必要闭合 15
2.3 如果标记中间代码超过20行，则应在标记末尾加注标记 15
3. CSS 代码风格规定 16
3.1 代码使用半展开 16
3.2 使用Tab作为缩进，并设立缩进大小为4 16
3.3 代码注释 16
3.4 代码编写 16
3.5 嵌入式样式比例不超过样式表代码总量10% 17
3.6 内联式样式比例不超过样式表代码总量30% 17
3.7 外联式样式表比例不少于样式表代码总量60% 17
4. JavaScript 代码风格规定 18
4.1 代码使用半展开 18
4.2 使用Tab作为缩进，并设立缩进大小为4 18
4.3 代码注释 18
4.4 不得浮现内嵌式代码 18
4.5 内联式代码占JavaScript总量不得超过40% 18
4.6 外联式代码占JavaScript总量至少为60% 19
1. C# 代码风格规定
1.1注释
类型、属性、事件、办法、办法参数，依照需要添加注释。
如果类型、属性、事件、办法、办法参数名称已经是自解释了，不需要加注释；否则需要添加注释。
当添加注释时，添加方式如下图所示：

1.2 类型（类、构造、委托、接口）、字段、属性、办法、事件命名
优先考虑英文，如果英文没有适当单词描述，可以使用拼音，使用中文是不符合规定。
唯一可以使用中文地方是枚举枚举项，枚举项实际已经不属于本节标题范畴了。这里只是放到一起阐明，如下图所示：

1.3 不使用缩写
所有类型、办法、参数、变量命名不得使用缩写，涉及人们熟知缩写，例如msg。
1.4 代码使用半展开
第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示：

第二步，进入“文本编辑器”，“C#”，“格式设立”，“新行”，取消掉右侧所有复选框中对号，如下图所示：

第三步，点击“拟定”，完毕设立。
1.5 使用Tab作为缩进，并设立缩进大小为4
第一步，打开Visual Studio，进入“工具”，“选项...”，如下图所示：

第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设立制表符。

第三步，点击“拟定”，完毕设立。
1.6 一种.cs源文献至多定义两个类型
如果两个类型关系是紧密有关，例如 产品、产品类型，此时Product类，和ProductType枚举可以定义在同一种Product.cs文献中。
但不能在一种.cs文献中浮现两个不有关类型定义，例如将 Product类和Reseller类（分销商）定义在一种BasicInfo.cs文献中。
1.7 类型名称和源文献名称必要一致
当类型命名为Product时，其源文献命名只能是Product.cs。
1.8 所有命名空间、类型名称使用Pascal风格（单词首字母大写）
如下图所示，红色标记为使用Pascal风格类型：

注意ProductType是私有类型，不论类型是公有还是私有，其命名总是采用Pascal风格。
1.9 本地变量、办法参数名称使用Camel风格（首字母小写，其后每个单词首字母大写）
红色标记为使用Camel风格变量或者办法参数：

1.10 私有办法、受保护办法，仍使用Pascal风格命名
示例代码如下：

1.11 如果if语句内容只有一行，可以不加花括号，但是必要和if语句位于同一行
范例1.9 中if判断事实上与下面语句是等效：

1.12 调用类型内部其她成员，需加this；调用父类成员，需加base
示例代码如下：

1.13 类型内部私有和受保护字段，使用Camel风格命名，但加“_”前缀
代码示例如下：

1.14 不能浮现公有字段
如果需要公有字段，使用属性进行包装。
1.15 类型成员排列顺序
类型成员排列顺序自上而下依次为：
字段：私有字段、受保护字段
属性：私有属性、受保护属性、公有属性
事件：私有事件、受保护事件、公有事件
构造函数：参数数量最多构造函数，参数数量中档构造函数，参数数量至少构造函数
办法：重载办法排列顺序与构造函数相似，从参数数量最多往下至参数至少。

1.16 委托和事件命名
委托以EventHandler作为后缀命名，例如 SalesOutEventHandler。
事件以其相应委托类型，去掉EventHandler后缀，并加上On前缀构成。
例如，对于SalesOutEventHandler委托类型事件，其事件名称为：OnSalesOut。
示例代码如下：

1.17 返回bool类型办法、属性命名
如果办法返回类型为bool类型，则其前缀为Is、Can或者 Try，例如：

1.18 常用集合类型后缀命名
凡符合下表所列集合类型，应添加相应后缀。
阐明
后缀
示例
数组
Array
int[] productArray
列表
List
List<Product> productList
DataTable/HashTable
Table
HashTable productTable
字典
Dictionary
Dictionay<string,string> productDictionary
EF中DbSet /DataSet
Set
DbSet<Product> productSet
1.19 常用后缀命名
凡符合下表所列局部变量、办法参数、字段、属性，均需添加相应后缀。
阐明
后缀
示例
示例阐明
费用有关
Cost
ShipCost
运送费
价格有关
Price
ProductUnitPrice
产品单价
消息有关
Message（弃用Note）
SuccessMessage
成功消息
日期有关
Date（弃用Time）
OrderDate
下单日期
计数、数量有关
Count（弃用Time）
LoginCount
登录次数
链接地址有关
Url
BlogUrl
博客链接
图片有关
Image
SignImage
签名图片
金额有关
Amount
PrepaidAmount
预付款
点数、积分有关
Point
MemberPoint
会员积分
记录、日记有关
Record（弃用Log）
ErrorRecord
错误记录
配备有关
Config
DataBaseConfig
数据库配备
状态有关
Status
OrderStatus
订单状态
模式、方式有关
Mode
OpenMode
打开方式
种类有关
Category / Type 二选一
UserCategory
顾客种类
工厂类有关
Factory
ConnectionFactory
连接工厂
启用有关
Enabled
ExportEnabled
启动导出
流有关
Stream
UploadStream
上传流
读取器有关
Reader
ExcelReader
Excel读取器
写入器有关
Writer
ExcelWriter
Excel写入器
适配器有关
Adapter
IntroOPAdapter
IntroOP适配器
提供器有关
Provider
MemebershipProvider
会员信息提供器
包装器有关
Wrapper
ProductWrapper
Product包装器
连接有关
Connection
ExcelConnection
Excel连接
1.20 常用类型命名
凡存在下表中类型，需采用下表指定名称命名。
类型
命名
类型
命名
客户
Customer
分销商
Reseller
零售商
Retailer
经销商/批发商
Dealer
顾客
UserInfo（User为数据库核心字）
订单
OrderInfo（Order为数据库核心字）
供应商
Supplier
管理员
Admin
密码
Password
会员
Member
评论
Remark（弃用Comment）
文章
Article
新闻
News
发票
Invoice
导入
Import
导出
Export
公司、公司
Company（弃用Enterprise）
产品
Product
省份
Province
都市
City
区县
District
地址
Address
角色
Role（弃用Group）
权限
Authority（弃用Permission）
仓库
Warehouse
工厂
Plant
登录
Login（弃用SignIn）
登出
LogOut（弃用SignOut）
创立
Create（弃用Add）
编辑
Edit
更新
Update
删除
Remove（弃用Delete）
照片
Photo
图片
Image
1.21 常用字段、属性命名
字段、属性种类比较繁杂，因而仅列出最惯用几项。
类型
名称
类型
名称
Id（int型）
Id（“d”小写，弃用ID）
GuidId（Guid型）
Id
Name
名称
Title
标题
Remark
备注、描述（弃用Memo、Description）
Category
种类（弃用Class、Type）
Linkman
联系人

2. XHTML 代码风格规定
2.1 如果XHTML标记有层次，那么代码也要有层次
下面是书写符合规定例子：

下面是书写 不符合规定 例子：

2.2 所有标记必要闭合
示例代码如下：

2.3 如果标记中间代码超过20行，则应在标记末尾加注标记
标注方式如下：

3. CSS 代码风格规定
3.1 代码使用半展开
设立办法参照1.4节。
3.2 使用Tab作为缩进，并设立缩进大小为4
设立办法参照1.5节。
3.3 代码注释
注释重要阐明该样式应用于页面哪个某些，而非阐明样式应用效果，代码注释风格如下所示：

3.4 代码编写
每一种样式设立必要独占一行，不能位于同一行，下面是符合规定写法：

下面是 不符合规定 写法：

3.5 嵌入式样式比例不超过样式表代码总量10%
嵌入式样式为直接写在HTML标记内部样式，如下图所示：

3.6 内联式样式比例不超过样式表代码总量30%
内联式样式为写在<head></head>中样式，如下图所示：

内联式样式，不能 写在<body></body>之间。
3.7 外联式样式表比例不少于样式表代码总量60%
外联式样式表为写在.css文献中样式，通过link引入到XHTML页面中，如下图所示：

4. JavaScript 代码风格规定
4.1 代码使用半展开
设立办法参照1.4节。
4.2 使用Tab作为缩进，并设立缩进大小为4
设立办法参照1.5节。
4.3 代码注释
代码注释需要阐明“函数功能”、“入口参数”、“返回值”，注释范例如下：

其中第一行阐明函数功能；第二行阐明入口参数；最后一行阐明返回值
4.4 不得浮现内嵌式代码
内嵌式代码是指写在XHTML标记中JavaScript代码，下面写法是 不符合规定 ：

4.5 内联式代码占JavaScript总量不得超过40%
内联式代码是指写在<head />或者<body />之间代码：

4.6 外联式代码占JavaScript总量至少为60%
外联式代码指写在单独.js文献中，然后通过script标记连接到XHTML页面中代码。