【C#】——系统编码规范
开发程序时,往往会有很多人参与,为了时程序与代码风格标准化,以便于时每个参与才发的人员尽可能直观地查看和理解其他人编写的代码,需要在编码之前制定一套统一的编码规范。
下面介绍一套C#中常用的编码规范供大家参考。
1.数据库命名规范
1. 数据库
数据库命名以字母 db 开头(小写),后面加数据哭相关英文单词或缩写。
数据库名称 | 描述 |
---|---|
db_JFCG | 机房重构数据库 |
2. 数据表
数据表以字母 tb 开头(小写),后面家数据表相关英文单词或缩写。
数据表名称 | 描述 |
---|---|
tb_Login | 登录信息表 |
3. 字段
字段一律采用英文单词或词组命名,如果找不到专业的英文单词或词组,可以用相同意义的英文单词或词组代替。
字段名称 | 描述 |
---|---|
name | 名字 |
pwd | 密码 |
4. 视图
视图命名以字母 view 开头(小写),后面加表示该视图作用的相关英文单词或缩写。
view_AdminInfo | 视图全名 |
---|---|
view | 视图 |
AdminInfo | 查看管理员信息 |
5. 存储过程
存储过程命名以字母 proc 开头(小写),后面加表示该存储过程作用的相关英文单词或缩写。
proc_Login | 存储过程全名 |
---|---|
proc | 存储过程 |
Login | 实现登录功能 |
6. 触发器
触发器命名以字母 trig 开头(小写),后面加表示该触发器作用的相关英文单词或缩写。
trig_inAdmin | 触发器全名 |
---|---|
trig | 触发器 |
inAdmin | 添加管理员信息 |
在数据库中使用代码规范,有助于其他用户更好地理解数据表及表中个字段的内容。
程序代码命名规范
1. 变量及对象名称定义规则
根据不同的程序需求,编写代码时需要定义一定的变量或常量。
变量及常量级别 | 命名规则 | 举例 |
---|---|---|
模块级常量 | M_+数据类型简写+变量名称 | M_int_xx |
全局变量 | G_+数据类型简写+变量名称 | G_int_xx |
局部变量 | P_+数据类型简写+变量名称 | P_dbl_sl |
模块级常量 | Mc_+数据类型简写+常量名称 | Mc_str_xx |
全局常量 | Gc_+数据类型简写+常量名称 | Gc_str_xx |
过程级常量 | Pc_+数据类型简写+常量名称 | Pc_str_xx |
2. 数据类型简写规则
程序中定义常量、变量或方法等内容时,常常需要制定类型。
数据类型 | 简写 | 数据类型 | 简写 |
---|---|---|---|
整型 | int | 长整型 | lint |
字符串 | str | 单精度浮点型 | flt |
布尔型 | sint | 字节型 | bt |
3. 控件命名规则
控件 | 缩写形式 | 控件 | 缩写形式 |
---|---|---|---|
Form | frm | CheckedListBox | clbox |
TextBox | txt | RadioButton | rbtn |
Button | btn | Panel | pl |
ComboBox | cbox | GroupBox | gbox |
Label | lab | TabControl | tcl |
DataGridViw | dgv | ErrorProvider | eprp |
ListBox | lb | ImageList | ilist |
Timer | tmr | HelpProvider | hpro |
CheckBox | chb | ListView | lv |
LinkLabel | llbl | TreeView | tv |
RichTextBox | rtbox | NotifyIcon | nicon |
NumericUpDown | nudown | DateTimePicker | dtpicker |
MonthCalendar | mcalen | ToolTip | ttip |
c#特殊编码规范
1. 窗体命名规范
在创建一个窗体时,首先对窗体的 ID 进行命名,其中窗体名称最好时英文形式的窗体说明,便于开发者通过窗体 ID 就能知道该窗体的作用。
在窗体中调用其他窗体时,必须对调用窗体进行引用,其引用的变量名为“Frm+窗体名称。”
2. 添加、修改操作中各控件的命名规范
在对数据进行编辑时,如果数据表中的字段过多,很难将窗体中对应的控件值组合程SQL语句。为了便于对数据库中的信息进行添加、修改操作,各字段所对应的控件名为“表明(或部分表名)_数字”,这里的数字是根据数据表中相应字段的顺序进行编号的。
3. 查询操作中各控件的命名规范
当使用多字段对数据好中的数据进行查询时,将窗体中相应的控件值组合成查询语句是非常麻烦的,为了能够快速组合查询条件,可以将设置查询条件的控件命名为“表名相应字段名”。当查询条件需要逻辑运算符时,将记录逻辑云端福的控件命名为“相应字段名+Sign”。这样即可通过字段名来组合查询条件。
小结
在项目中使用良好的命名规则,有助于开发者快速了解编写后的变量、方法、类、窗体以及各控件的用处。