C#编码规范
这些规范来源于很多地方，好好约束自己写代码格式。
1.控件缩写
C# 控件名称缩写介绍（转）
公共控件
Button btn 按钮
CheckBox chk 复选框
CheckedListBox ckl 显示一个项列表,其中每一项左侧都有一个复选框
ComboBox cmb 下拉列表框
DateTimePicker dtp 时间控件
Label lbl 文本列表
LinkLabel llb 支持超链接的文本标签
ListBox lst 显示用户可以从中选择项的列表
ListView lvw 可使用四种不同视图显示项目
MaskedTextBox mtx 使用掩码区分正确的和不正确的用户输入
MonthCalendar cdr 显示用户可以从中选择日期的月历
NotifyIcon icn 程序运行时在任务栏右侧通知区域显示的图标
NumeircUpDown nud 指定支持事务处理处始化
PictureBox pic 显示图像
ProgressBar prg 显示一个向用户表明操作进度的填充条
RadioButton rdo 单选按钮
RichTextBox rtx 富文本框
TextBox txt 文本框
ToolTip tip 当用户针行移过关联控件时显示的信息
TreeView tvw 向用户显示可选择包含图片的标签项的分层集合
WebBrowser wbs 允许用户在窗体内浏览网页 容器控件
FlowLayoutPanel flp 处理其组件的布局,并在流布局中自动排列它们
GroupBox grp 在一组件周围显示带有可选标题的框架
Panel pnl 允许对控件集合分组
SplitContainer spl 把容器显示区域分成两块,并可以向其中添加控件
TabControl tab 显示包含组件和控件的相关选项卡的集合
TableLayoutPanel tlp 处理其组件的布局并以表的形式自动排列它们 菜单和工具栏
ContextMenuStrip cms 当用户右击关联菜单时显示快捷菜单
MenuStrip mns 窗体顶部菜单项
StatusStrip ssr 窗体底部状态栏
ToolStrip tsr 常见的顶部菜单下的工具条
ToolStripContainer tsc 窗体四周包含面板,面板包含一个或多个菜单
数据
DataSet dts 数据集
DataGridView dgv 显示网格中可以自定义的行和列
BindingSource bds 封装的窗体数据源并提供导航筛选排序更新功能
BindingNavigator bdn 指定支持事务处理初始化
ReportViewer rpv
对话框
ColorDialog cld 颜色对话框
FolderBrowserDialog fbd 打开文件目录对话框
FontDialog fnd 字体对话框
OpenFileDialog ofd 打开文件对话框
SaveFileDialog sfd 保存文件对话框
组件
BackgroundWorker bgw 在单独的线程上执行操作
DirectoryEntry dre 封装activedirectory层次结构中的一个节点或对象
DirectorySearcher drs 对Active Diretory执行查询
ErrorProvider err 指定支持事务处理初始化
EventLog evl 指定支持事务处理初始化
FileSystemWatcher fsw 指定支持事务处理初始化
HelpProvider hlp 为控件提供弹出帮助或联机帮助
ImageList img 管理通常由其它控件使用的图像集合
MessageQueue msq 提供对消息对列服务器上队列的访问权
PerformanceCounter pfc 表示windows性能计数器组件
Process prc 对本地(启用开始和停止功能)和远程进程的访问,
SerialPort spt 表示串行端口资源
ServiceController scl 提供对windows服务的连接查询和操作的功能
Timer tmr 按用户定义的时间间隔引发事件的组件
印刷
PageSetupDialog psd 允许用户更改与页面相关的打印设置
PrintDialog prd 允许用户选择打印机和打印选项
PrintDocument pdc 定义一个向打印机发送输出的对象
PrintPreviewControl prv 表示打印预览中显示正在预览的部分
PrintPreviewDialog ppd 向用户显示关联文档打印时的样子
水晶报表
MicrosoftReportViewer 显示报表
CrystalReportViewer crv
ReportDocument rpd
其他
DomainUpDown dud
HScrollBar hsc
PropertyGrid prg
Splitter spl
TrackBar trb
VScrollBar vsc
|
组件类型 |
缩写 |
例子 |
|
Label |
Lbl |
lblNote |
|
TextBox |
Txt |
txtName |
|
Button |
Btn |
btnOK |
|
ImageButton |
Ib |
ibOK |
|
LinkButton |
Lb |
lbJump |
|
HyperLink |
Hl |
hlJump |
|
DropDownList |
Ddl |
ddlList |
|
CheckBox |
Cb |
cbChoice |
|
CheckBoxList |
Cbl |
cblGroup |
|
RadioButton |
Rb |
rbChoice |
|
RadioButtonList |
Rbl |
rblGroup |
|
Image |
Img |
imgBeauty |
|
Panel |
Pnl |
pnlTree |
|
TreeView |
Tv |
tvUnit |
|
WebComTable |
Wct |
wctBasic |
|
ImageDateTimeInput |
Dti |
dtiStart |
|
ComboBox |
Cb |
cbList |
|
MyImageButton |
Mib |
mibOK |
|
WebComm.TreeView |
Tv |
tvUnit |
|
PageBar |
Pb |
pbMaster |
2
代码行注释规范来源于http://www.cnblogs.com/wulinfeng/archive/2012/08/31/2664720.html
1> 如果处理某一个功能需要很多行代码实现，并且有很多逻辑结构块，类似此种代码应该在代码开始前添加注释，说明此块代码的处理思路及注意事项等
2> 注释从新行增加，与代码开始处左对齐
3> 双斜线与注释之间以空格分开，示例图如下所示：
3 变量注释规范
1> Class级变量应以采用 /// 形式自动产生XML标签格式的注释，示例图如下所示： 
2> 方法级的变量注释可以放在变量声明语句的后面，与前后行变量声明的注释左对齐，注释与代码间以Tab隔开。
下表描述了不同类型标识符的大小写规则：
|
标识符 |
大小写 |
示例 |
|
命名空间 |
Pascal |
namespace Com.Techstar.ProductionCenter |
|
类型 |
Pascal |
public class DevsList |
|
接口 |
Pascal |
public interface ITableModel |
|
方法 |
Pascal |
public void UpdateData() |
|
属性 |
Pascal |
Public int Length{…} |
|
事件 |
Pascal |
public event EventHandler Changed; |
|
私有字段 |
Camel |
private string fieldName; |
|
非私有字段 |
Pascal |
public string FieldName； |
|
枚举值 |
Pascal |
FileMode{Append} |
|
参数 |
Camel |
public void UpdateData(string fieldName) |
|
局部变量 |
Camel |
string fieldName; |
3> 对常见缩略词，两个字母的缩写要采用统一大小写的方式（示例：ioStream， getIOStream）；多字母缩写采用首字母大写，其他字母小写的方式（示例： getHtmlTag）；
4> 避免使用长名字（最好不超过 15 个字母）。
5> 避免使用相似或者仅在大小写上有区别的名字。
4 各种标示符类型的命名约定
1> 程序集命名
实验室名称（Lab）+ 项目名称 + 模块名称（可选），例如：
中心服务器程序集：Lab.SeverCenter；
中心服务器业务逻辑程序集：Lab.SeverCenter.Business；
2> 命名空间命名
采用和程序集命名相同的方式：实验室名称（Lab）+ 项目名称 + 模块名称。 另外，一般情况下建议命名空间和目录结构相同。例如：
中心服务器：Lab.SeverCenter；
中心服务器下的用户控件：Lab.SeverCenter.UserControl；
中心服务器业务逻辑：Lab.SeverCenter.Business；
中心服务器数据访问：Lab.SeverCenter.Data；
3> 程序集和DLL
l 大多数情况下，程序集包含全部或部分可重用库，且它包含在单个动态链接库(DLL) 中。
l 一个程序集可拆分到多个DLL 中，但这非常少见，在此准则中也没有说明。
l 程序集和DLL 是库的物理组织，而命名空间是逻辑组织，其构成应与程序集的组织无关。
l 命名空间可以且经常跨越多个程序集。可以考虑如下模式命名DLL：
<Company>.<Component>.dll
例：Lab.SeverCenter.dll
4> 类和接口命名
l 接口的名字要以字母I开头。保证对接口的标准实现名字只相差一个“I”前缀，例如对IComponent接口的标准实现为Component；
l 泛型类型参数的命名：命名要为T或者以T开头的描述性名字，例如：
public class List<T>
public class MyClass<Tsession>
5> 方法命名
l 第一个单词一般是动词；
l 如果方法返回一个成员变量的值，方法名一般为Get+成员变量名，如若返回的值 是bool变量，一般以Is作为前缀。另外，如果必要，考虑用属性来替代方法；
l 如果方法修改一个成员变量的值，方法名一般为：Set + 成员变量名。同上，考虑 用属性来替代方法。
