变量命名规范（C#，SQL，前端）

 

总则

1、变量命名包含两部分：头部+内容部分（其中头部一般为类型缩写，内容部分具体按变量作用命名。如 intNumber）

2、内容名默认为英文单词，若为中文拼音，则在最后补充 _cn，如 intShuZi_cn

3、变量命名方式以驼峰方式，如 intParameterCount

 

1、C#

变量命名

1、以变量关键字缩写开头（int、str、bol 等），如 intNumber（int型），strText（string型），clsClass（类）

2、大部分关键字缩写为3个字母，少部分可以考虑1个或2个字母，如：

　　o 对应 object（实例化的 class）

　　dt 对应 DateTime

自定义类命名

面向对象基本上都是类，故而放弃 cls 开头的命名方式。而是以类名结尾区分类的作用，且所有类以大写字母开头：

（以区分类和对象，这种命名方式是我同事 catacat 提出）

无尾部    普通类

Model    模型（如：UserModel），分两种，一种为实体模型（对应数据库的表），另一种为数据模型（没有数据库表），一般只有属性，没有方法

　　ViewModel    视图数据模型（一般用于视图显示、视图表单提交。如：PwdRstViewModel 密码重置视图模型）

　　ReturnModel    返回数据模型（一般用于格式化返回数据）

Repository    仓储层类

Service    服务层类

 其他自行扩充，如 Mapping（映射关系）

 

2、SQL

表

表的种类比较多，但都以 t 开头，第二个字母表示表的类型，如 tbUser（用户表），trSystemLog（系统日子记录表）

tb    （table）业务表

tr    （r 为 record）记录表，如日志表、API调用记录表等

td    （d 为 dictionary）字典表

ts    （s 为 status）状态表（如：tsQueue，队列调用状态表）

视图

视图是一般由多张 table 关联，这里不再区分视图的作用，故而视图都是以 v 开头

v    （view）视图

特别的，视图内的表若是带了 with(nolock)，将会以 vw 开头，标识这个视图已实现不锁表查询（查询时可不添加 with(nolock) ）

函数

ft    （function table）表值函数

fv    （function value）标量值函数

　　fs    （function scalar）标量值函数（弃用）

fg    （function group）聚合函数

存储过程

p     普通存储过程

pf    （procedure function）实现某种功能的存储过程

pr    （procedure report）报表数据源

pt    （procedure task）作业（用于数据库作业）

 

3、前端

Html 部分

class 的命名应该要有层级

id 命名可考虑以  i- 开头，如 i-body（方便与 class 区分）

JS部分

一般以一个字母开头，如 i 表数字，s 表字符串，o 表object， e 表element，b 表bool，

特别的，有 md 表模块（module）

 

附录：

循环用：i，j，k

 数量：n，m