程序规范
1、 命名中使用英文名称，杜绝使用拼音、英文首字母组合。
2、 命名空间、类命名定义采用英文首字母大写，如：UserInfo，接口采用：IUser
3、 页面空间命名使用开头3字母前缀。详细见附表：
4、 私有变量、局部变量采用首字母小写，后面的单词首字母大写，如：userName
5、 公共变量及属性采用单词首字母大写，如：UserName
6、 方法名称统一使用单词首字母大写，并使用动名词形式，如：SetUserName。方法中的参数采用私有变量的命名方式。
7、 if、while、for、foreach等语句即使后面只有一句逻辑，也要使用大括号。
8、 大括号“{”、“}”放在单独的行中。
9、 .cs文件开头需使用注释说明建立者，建立日期等注释。
// ==========================================
// Author:<AuthorName>
// Create date: <Create Date>
// Description: <Description>
// ==========================================
10、 类、方法、属性注释，采用标准注释。即连续打三个“/”开发环境自动生成注释框架。
11、 除非在类构造函数中（用于区别构造函数参数与类私有变量），否则避免使用this关键字引用类的私有变量。
12、 常量命名全部使用大写单词，单词之间使用下划线“_”连接。
13、 修饰符，如：public、protected、private等，在限定类或者方法的时候最小化作用范围。
14、 在引用命名空间的时候，系统命名空间在上，自定义命名空间在下。系统和自定义命名空间之间留空行。
15、 在引用类、函数、变量时不能使用完全限定名，必须引用命名空间后使用。（继承Page除外）
16、 方法之间必须有空行隔开。
17、 语句缩进，应使用TAB进行缩进，设置开发环境一个TAB显示宽度等于4个空格宽度。
18、 程序行之间采用逻辑块之间增加空行，每行之间没有空行与都有空行会降低程序可读性。
19、 页面文件命名采用单词首字母大写，如：UserList.aspx其中页面推荐命名：
✧ 列表页面使用类似XxxxxList.aspx方式命名。
✧ 数据新增页面使用类似：XxxxxAdd.aspx方式命名。
✧ 数据编辑页面使用类似：XxxxxEdit.aspx方式命名。
✧ 统计界面使用类似：XxxxxStat.aspx方式命名。
✧ 详细数据浏览使用类似：XxxxxView.axpx方式命名。
✧ 综合查询功能页面使用类似：XxxxxSearch.aspx方式命名。
✧ 多语言化页面要在App_GlobalResources、App_LocalResources文件夹下面对应相应的文件名建立文本文件，如：，此文件描述需要多语言化的内容。
注：英文全称存在简写的，可使用简写。如：Information可使用Info，Statistic可使用Stat。表示状态的Status使用全称。
尽量使用英文中原有的简写，不要自创简写。
更多请参见附录：
数据库规范
1、 数据库表、视图、存储过程命名按照如下格式：
表：T_User，视图V_User，存储过程P_UserList，主键PK_UserId，外键FK_外键表名_外键字段名，索引IX_LoginId。
规则为开头简写大写字母加下划线加全称英文单词，英文单词首字母大写。
2、 数据库语句中SQL关键字，系统默认参数、变量全部大写，数据类型除外，如：nvarchar(50)。
3、 数据库存储过程参数采用@+英文全称的命名方式，如：@UserId，英文单词首字母大写。
4、 多表交叉查询语句不使用表别名，使用完整的限定名。
5、 查询语句中的字段大小写于数据表设计时使用的大小写一样。
6、 语句缩进，应使用TAB进行缩进，设置开发环境一个TAB显示宽度等于4个空格宽度。
7、 不应在任何Sql语句中使用SELECT * FROM …，必须使用完整的列名称。
8、 代码中使用BEGIN END语句块，并缩进，提高可读性。
9、 存储过程事务规则：
在没有特殊需要自己控制回滚的情况下建议采用：
SET XACT_ABORT ON
BEGIN TRANSACTION
这里是多表操作逻辑
COMMIT TRANSACTION
存储过程标准注释参考：
-- =============================================
-- Author: <Author,,Name>
-- Create date: <Create Date,,>
-- Description: <Description,,>
-- =============================================
CREATE PROCEDURE <Procedure_Name, sysname, ProcedureName>
-- Add the parameters for the stored procedure here
<@Param1, sysname, @p1> <Datatype_For_Param1, , int> = <Default_Value_For_Param1, , 0>,
<@Param2, sysname, @p2> <Datatype_For_Param2, , int> = <Default_Value_For_Param2, , 0>
AS
BEGIN
-- SET NOCOUNT ON added to prevent extra result sets from
-- interfering with SELECT statements.
SET NOCOUNT ON;
-- Insert statements for procedure here
SELECT <@Param1, sysname, @p1>, <@Param2, sysname, @p2>
END
GO
控件命名
注：该空间命名前缀仅适用于*.aspx页面上面的控件ID的命名。如果是在*.aspx.cs文件中自己写的动态生成控件的命名，遵循一般的变量命名规则。
类型 | 前缀 | 示例 |
Label | lbl | lblUserName |
TextBox | tbx | |
Panel | pnl | |
Button | btn | |
LinkLabel | llb | |
CheckBox | cbx | |
RadioButton | rbn | |
GroupBox | gbx | |
PictureBox | pbx | |
Repeater | rpt | |
DataList | dlt | |
GridView | gdv | |
DataGrid | dtg | |
ListBox | lbx | |
CheckedListBox | clb | |
ComboBox | cmb | |
ListView | ltv | |
TreeView | trv | |
TabControl | tbc | |
DateTimePicker | dtp | |
MonthCalendar | mcd | |
HScrollBar | hsb | |
VScrollBar | vsb | |
Timer | tmr | |
Spliter | spl | |
DomainUpDown | dud | |
NumericUpDown | nud | |
TrackBar | tkb | |
ProcessBar | prb | |
RichTextBox | rtb | |
ImageList | iml | |
HelpProvider | hlp | |
ToolTip | tlt | |
ContextMenu | ctm | |
ToolBar | tlb | |
StatusBar | stb | |
NotifyIcon | nti | |
OpenFileDialog | 文件名的命名规则 ofd | |
SaveFileDialog | sfd | |
FolderBrowserDialog | fbd | |
FrontDialog | ftd | |
ColorDialog | cld | |
PrintDialog | ptd | |
PrintPreviewDialog | ppd | |
PrintPreviewControl | ppc | |
ErrorPrivider | erp | |
PrintDocument | prd | |
PageSetupDialog | psd | |
CrystalReportViewer | crv | |
附录：（如附录与正本中的规则规范冲突，请以正本为准。）
一、 名称准则
对于组成类库的元素（包括程序集、命名空间、类型、成员和参数），命名准则提供如何为这些元素选择合适的标识符的准则。选择符合这些准则的标识符可以提高您的库的可用性，并使用户相信您的库将不需要学习一组新的规则。
为了提供一致的开发人员体验，公共公开的元素（如公共类和受保护的方法）必须遵守这些准则。然而，为在整个代码中保持一致性以及改进可维护性，应考虑在整个代码中始终使用这些约定。
1、 大小写约定
许多命名约定都与标识符的大小写有关。值得注意的是，公共语言运行库 (CLR) 支持区分大小写和不区分大小写的语言。本主题中描述的大小写约定可帮助开发人员理解和使用库。
大小写样式
下列术语描述了标识符的不同大小写形式。
Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如：
BackColor
大小写混合
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：
backColor
大写
标识符中的所有字母都大写。例如：
IO
标识符的大小写规则
如果标识符由多个单词组成，请不要在各单词之间使用分隔符，如下划线（“_”）或连字符（“-”）等。而应使用大小写来指示每个单词的开头。
下列准则是用于标识符的通用规则。
对于由多个单词组成的所有公共成员、类型及命名空间名称，要使用 Pascal 大小写。
注意，这条规则不适用于实例字段。由于成员设计准则中详细说明的原因，不应使用公共实例字段。
对参数名称使用大小写混合。
下表汇总了标识符的大小写规则，并提供了不同类型标识符的示例。
标识符 | 大小写方式 | 示例 |
类 | Pascal | AppDomain |
枚举类型 | Pascal | ErrorLevel |
枚举值 | Pascal | FatalError |
事件 | Pascal | ValueChanged |
异常类 | Pascal | WebException |
只读的静态字段 | Pascal | RedValue |
接口 | Pascal | IDisposable |
方法 | Pascal | ToString |
命名空间 | Pascal | System.Drawing |
参数 | Camel | typeName |
属性 | Pascal | BackColor |
首字母缩写词的大小写规则
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论