C#编码规范(范本) 下载本文

内容发布更新时间 : 2024/6/9 3:09:37星期一 下面是文章的全部内容请认真阅读。

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

例如:

应收帐款批次转凭证窗体的完整窗体名为frmTransferAccountsReceivable.cs,这时的窗体文件名太长,可以采用简写的方式,应收帐款专业简写为AR,我们可以采取这种公认的或专业的简写名词命名,最后可以命名为frmTransAR

非标准缩写单词采用去掉元音字母或半元音字母的方式命名,重复字只取一个。例如:Button:btn,省图掉u,o和t。 4. 文件名要和类名匹配

例如,对于类HelloWorld, 相应的文件名应为 HelloWorld.cs (或, HelloWorld.vb) 5. 文件类型前缀一览表(/表示暂无前缀)

Win Form 扩展名 Extension File Name 描述 Description 前缀 Prefix .cs .cs 窗体文件 类文件 Web Form frm / 扩展名 Extension File Name 描述 Description 前缀 Prefix .aspx .ascx Web用户自定义控件 / wuc

回目录

五、控件命名规范

1. C#编码时,为了更直观地遍历整个窗体的控件,通常的作法是给每一种类型的控件的名称前增加统一的前缀。前缀字符采用三个小写字母的形式表示(一般常用的控件三个字母都可以满足,也有一些控件无法更好地用三个字母缩写,详见下面的表格。)

例如:

海南蓝点

第 6 页 共 23 页

Print Date:2020-03-03

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

一个开始处理的按钮可以命名为:btnBeginProc

2. 控件主体名称采用名词或动名词的形式命名

例如:

1. 一个单号的标签:lblDocNo

2. 一个开始处理的按钮:btnBeginProc 3. 控件主体名采用单词首字大写的形式命名

例如:

一个产生应收帐款的按钮可以命名为:btnMakeAR

回目录

5.1 Win Form内部控件命名规范

控件类型 Control Type 前缀 Prefix 例子 Example Label LabelLink Button TextBox MainMenu CheckBox RadioButton GroupBox PictureBox Panel DataGrid ListBox CheckedListBox Combo ListView TreeView TabControl 海南蓝点 lbl lbk btn txt mnu chk rdo grp pic pan grd lst chklst cbo lstv trv tab 第 7 页 共 23 页 lblStartSync Print Date:2020-03-03

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

DateTimerPicker MonthCalendar HScrollBar VScrollBar Timer Splitter DomainUpDown NumericUpDown TrackBar ProgressBar RichTextBox ImageList HelpProvider ToolTip ContextMenu ToolBar StatusBar NotifyIcon OpenFileDialog SaveFileDialog FolderBrowserDialog FontDialog ColorDialog PrintDialog PrintPreviewDialog PrintPreviewControl ErrorProvider PrintDocument PageSetupDialog CrystalReportViewer dtp cld hsb vsb tmr spl dup nup trk pgr rtxt imglst hlp tlp mnu tlb sta nti ofd sfd fbd fdg cdg pdg ppd ppc erp prd psd crv 回目录

5.2 Web Form内部控件命名规范

控件类型 Control Type 前缀 Prefix 例子 Example Print Date:2020-03-03

海南蓝点 第 8 页 共 23 页

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

Label TextBox Button LinkButton ImageButton HyperLink DropDownList ListBox DataGrid DataList Repeater CheckBox CheckBoxList RadioButtonList RadioButton Image Panel PlaceHolder Calendar AdRotator Table RequireFieldValidator CompareValidator RangeValidator CustomValidator ValidationSummary Xml Litteral CrystalReportViewer lbl txt btn lbtn ibtn hlk ddl lst grd dlst rep chk chklst rdolst rdo img pan plh cld adr tbl rfv cpv rgv cstv vls xml ltl crv lblTip txtName btnOK 回目录

RegularExpressionValidator rev 5.3 C#数据组件命名规范

数据库对象 Data Object 前缀 Prefix 例子 Example Print Date:2020-03-03

海南蓝点 第 9 页 共 23 页

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

DataSet DataTable DataTableCollection DataView DataRow DataRowCollection DataColumn DataColumnCollection DataRowView OleDb Data Provider OleDbDataAdapter OleDbConnection OleDbCommand Sql Server Data Provider SqlDataAdapter SqlConnection SqlCommand Odbc Data Provider OdbcDataAdapter OdbcConnection OdbcCommand Oracle Data Provider OracleDataAdapter OracleConnection OracleCommand ds dt dtc dv dr drc dc dcc drv oleadp oleconn olecmd sqladp sqlconn sqlcmd odbcadp odbcconn odbccmd oraadp oraconn oracmd dsDept dtDept dtcDept dvDept drDept drcDept dcField dccDept drvDept 回目录

5.4 C#菜单命名规范

应用程序频繁使用许多菜单控件,对于这些控件具备一组唯一的命名约定很实用。除了最前面 \标记以外,菜单控件的前缀应该被扩展:对每一级嵌套增加一个附加前缀,将最终的菜单的标题放在名称字符串的最后。下表列出了一些例子。 菜单标题序列 菜单处理器名称 File Open File Send Email 海南蓝点

mnuFileOpen mnuFileSendEmail 第 10 页 共 23 页

Print Date:2020-03-03