.Net 项目代码风格要求小结(3)

凡存在下表中的类型,需采用下表指定的名称命名。

类型   命名   类型   命名  
客户   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标记有层次,那么代码也要有层次

下面是书写符合要求的例子:

.Net 项目代码风格要求小结

下面是书写 不符合要求 的例子:

.Net 项目代码风格要求小结

2.2 所有标记必须闭合

示例代码如下:

2.3 如果标记中间代码超过20行,则应在标记末尾加注标识

标注方式如下:

.Net 项目代码风格要求小结

3. CSS 代码风格要求3.1 代码使用半展开

设置方法参考1.4节。

3.2 使用Tab作为缩进,并设置缩进大小为4

设置方法参考1.5节。

3.3 代码注释

注释主要说明该样式应用于页面的哪个部分,而非说明样式的应用效果,代码注释风格如下所示:

.Net 项目代码风格要求小结

3.4 代码编写

每一个样式设置必须独占一行,不能位于同一行,下面是符合要求的写法:

下面是 不符合要求 的写法:

3.5 嵌入式样式的比例不超过样式表代码总量的10%

嵌入式样式为直接写在HTML标记内部的样式,如下图所示:

3.6 内联式样式的比例不超过样式表代码总量的30%

内联式样式为写在<head></head>中的样式,如下图所示:

.Net 项目代码风格要求小结

内联式样式,不能 写在<body></body>之间。

3.7 外联式样式表的比例不少于样式表代码总量的60%

外联式样式表为写在.css文件中的样式,通过link引入到XHTML页面中,如下图所示:

4. JavaScript 代码风格要求4.1 代码使用半展开

设置方法参考1.4节。

4.2 使用Tab作为缩进,并设置缩进大小为4

设置方法参考1.5节。

4.3 代码注释

代码注释需要说明“函数功能”、“入口参数”、“返回值”,注释范例如下:

.Net 项目代码风格要求小结

其中第一行说明函数功能;第二行说明入口参数;最后一行说明返回值

4.4 不得出现内嵌式代码

内嵌式代码是指写在XHTML标记中的JavaScript代码,下面的写法是 不符合要求 的:

4.5 内联式代码占JavaScript的总量不得超过40%

内联式代码是指写在<head />或者<body />之间的代码:

.Net 项目代码风格要求小结

4.6 外联式代码占JavaScript的总量至少为60%

外联式代码指写在单独的.js文件中,然后通过script标记连接到XHTML页面中的代码。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/wjwjyz.html