C#编码规范范本.docx

C#编码规范范本.docx

《C#编码规范范本.docx》由会员分享，可在线阅读，更多相关《C#编码规范范本.docx（26页珍藏版）》请在冰豆网上搜索。

C#编码规范范本

C＃编码规范

CodeSpecificationforC＃

（仅供内部使用Onlyforinsideofbpnet）

作者：

叶文良（WilliamYe）

日期：

2010年02月24日

C#编码规范－文档修改记录

CodeSpecificationforC#—RevisionHistory

版本号

Version

日期日期

RevisionDate

修改理由

Summary/Comment

修改作者

RevisionBy

修改的页数

RevisionPages

1.0

2010/02/24

Create

williamYe

ALL

一、目的

1.使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段编码。

2.好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。

回目录

二、适用范围

1.本规范不适用于数据库开发规范，数据库开发相关规范请参考相关文档；

2.本规范主要以C#为开发语言的规范，为开发部的原则性规范；

3.由于本规范是为撰写程序而设计，所以适用于一切有关程序撰写的工作事项。

对于具体的每个项目，可能需要对之进行裁剪和补存。

补存的内容确认之后公用的内容要更新到此规范中；

4.适用人员：

所有开发人员及代码品管人员；

5.适用产品：

所有以C#编写的代码。

回目录

三、命名空间

命名空间应使用解决方案的名称，每个项目应设置一个二级命名空间，并以项目名命名。

如下图：

SDP为解决方案（Solution）的名称，则SDP为顶级命名空间；

SDP.BF为项目名称（Assembly），则SDP.BF项目下的命名空间为：

SDP.BF.ClassName

回目录

四、文件命名规范

1.文件命名原则是更容易区分不同的文件类型，在文件名前增加三字符的前缀，前缀字母一律为小写

例如：

一个窗体文件可以增加frm前缀，frmForm1.cs

所有的前缀列表请参考本小节末尾的表格!

2.文件主体名必须用名词或动名词，且主体名必须是单词首字大写的方式表示

例如：

销货单的窗体可以命名为frmInvoice.cs，一张销货单批次作废的窗体可以命名为frmCancelInvoice.cs

3.文件名必须采用在不影响原意表达时尽量采用单词缩写的形式命名，以达到文件名的简洁明了的命名目的

例如：

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

非标准缩写单词采用去掉元音字母或半元音字母的方式命名，重复字只取一个。

例如：

Button：

btn,省图掉u,o和t。

4.文件名要和类名匹配

例如，对于类HelloWorld,相应的文件名应为HelloWorld.cs（或,HelloWorld.vb）

5.文件类型前缀一览表（/表示暂无前缀）

WinForm

扩展名

ExtensionFileName

描述

Description

前缀

Prefix

.cs

窗体文件

frm

.cs

类文件

/

WebForm

扩展名

ExtensionFileName

描述

Description

前缀

Prefix

.aspx

/

.ascx

Web用户自定义控件

wuc

回目录

五、控件命名规范

1.C#编码时，为了更直观地遍历整个窗体的控件，通常的作法是给每一种类型的控件的名称前增加统一的前缀。

前缀字符采用三个小写字母的形式表示（一般常用的控件三个字母都可以满足，也有一些控件无法更好地用三个字母缩写，详见下面的表格。

）

例如：

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

btnBeginProc

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

例如：

1.一个单号的标签：

lblDocNo

2.一个开始处理的按钮：

btnBeginProc

3.控件主体名采用单词首字大写的形式命名

例如：

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

btnMakeAR

回目录

5.1WinForm内部控件命名规范

控件类型

ControlType

前缀

Prefix

例子

Example

Label

lbl

lblStartSync

LabelLink

lbk

Button

btn

TextBox

txt

MainMenu

mnu

CheckBox

chk

RadioButton

rdo

GroupBox

grp

PictureBox

pic

Panel

pan

DataGrid

grd

ListBox

lst

CheckedListBox

chklst

Combo

cbo

ListView

lstv

TreeView

trv

TabControl

tab

DateTimerPicker

dtp

MonthCalendar

cld

HScrollBar

hsb

VScrollBar

vsb

Timer

tmr

Splitter

spl

DomainUpDown

dup

NumericUpDown

nup

TrackBar

trk

ProgressBar

pgr

RichTextBox

rtxt

ImageList

imglst

HelpProvider

hlp

ToolTip

tlp

ContextMenu

mnu

ToolBar

tlb

StatusBar

sta

NotifyIcon

nti

OpenFileDialog

ofd

SaveFileDialog

sfd

FolderBrowserDialog

fbd

FontDialog

fdg

ColorDialog

cdg

PrintDialog

pdg

PrintPreviewDialog

ppd

PrintPreviewControl

ppc

ErrorProvider

erp

PrintDocument

prd

PageSetupDialog

psd

CrystalReportViewer

crv

回目录

5.2WebForm内部控件命名规范

控件类型

ControlType

前缀

Prefix

例子

Example

Label

lbl

lblTip

TextBox

txt

txtName

Button

btn

btnOK

LinkButton

lbtn

ImageButton

ibtn

HyperLink

hlk

DropDownList

ddl

ListBox

lst

DataGrid

grd

DataList

dlst

Repeater

rep

CheckBox

chk

CheckBoxList

chklst

RadioButtonList

rdolst

RadioButton

rdo

Image

img

Panel

pan

PlaceHolder

plh

Calendar

cld

AdRotator

adr

Table

tbl

RequireFieldValidator

rfv

CompareValidator

cpv

RangeValidator

rgv

RegularExpressionValidator

rev

CustomValidator

cstv

ValidationSummary

vls

Xml

xml

Litteral

ltl

CrystalReportViewer

crv

回目录

5.3C#数据组件命名规范

数据库对象

DataObject

前缀

Prefix

例子

Example

DataSet

ds

dsDept

DataTable

dt

dtDept

DataTableCollection

dtc

dtcDept

DataView

dv

dvDept

DataRow

dr

drDept

DataRowCollection

drc

drcDept

DataColumn

dc

dcField

DataColumnCollection

dcc

dccDept

DataRowView

drv

drvDept

OleDbDataProvider

OleDbDataAdapter

oleadp

OleDbConnection

oleconn

OleDbCommand

olecmd

SqlServerDataProvider

SqlDataAdapter

sqladp

SqlConnection

sqlconn

SqlCommand

sqlcmd

OdbcDataProvider

OdbcDataAdapter

odbcadp

OdbcConnection

odbcconn

OdbcCommand

odbccmd

OracleDataProvider

OracleDataAdapter

oraadp

OracleConnection

oraconn

OracleCommand

oracmd

回目录

5.4C#菜单命名规范

应用程序频繁使用许多菜单控件，对于这些控件具备一组唯一的命名约定很实用。

除了最前面"mnu"标记以外，菜单控件的前缀应该被扩展：

对每一级嵌套增加一个附加前缀，将最终的菜单的标题放在名称字符串的最后。

下表列出了一些例子。

菜单标题序列

菜单处理器名称

FileOpen

mnuFileOpen

FileSendEmail

mnuFileSendEmail

FileSendFax

mnuFileSendFax

FormatCharacter

mnuFormatCharacter

HelpContents

mnuHelpContents

当使用这种命名约定时，一个特定的菜单组的所有成员一个接一个地列在.net的“属性”窗口中。

而且，菜单控件的名字清楚地表示出它们所属的菜单项。

回目录

六、变/常量命名规范

6.1变量范围前缀

1.为了更好地区分变量的有效范围，例如Class级变量，在定义变量名时用小写字母前缀区分。

2.此约定同样适用于常量的命名。

3.常量名必须大写。

回目录

6.2变量类型前缀

1.定义变量时根据不同的变量类型增加特定的变量类型前缀，一般为小写的三个字母表示

2.变量主体名与控件主体名和窗体主体名的命名方式一致，采用单词首字大写的方式命名

数据类型

Datatype

CLR类型

CLRType

前缀

Prefix

例子

Example

bool

System.Boolean

bln

byte

System.Byte

byt

sbyte

System.SByte

sbyt

char

System.Char

chr

decimal

System.Decimal

dec

double

System.Double

dbl

float

System.Single

flt

int

System.Int32

int

uint

System.UInt32

uint

long

System.Int64

lng

ulong

System.UInt64

ulng

short

System.Int16

sht

ushort

System.UInt16

usht

string

System.String

str

datetime

System.DateTime

dtm

object

System.Object

obj

枚举

enu

Structure

stru

综上所述，变量命名格式为：

<特殊类型前导字（都为小写字母）><类型前缀><变量名字>

特殊类型前导字：

前导字

数据型态

a

任何型态的数组（不区分为几维的数组）

m

Class级变量前缀

I

所有接口声明及变量都应以大写I作为前缀

E

枚举声明增加E前缀

有效变量定义的例子：

int[]aintCounters=newint[10];（表示一个方法级的整型计数器数组）

int[]maintCounters=newint[10];（表示一个class级的整型计数器数组）

回目录

七、方法命名规范

1.方法名的主体应该使用大小写混合形式，并且应该足够长以描述它的作用。

而且，方法名应该以一个动词起首，如InitNameArray或CloseDialog。

2.对于频繁使用的或长的项，推荐使用标准缩略语以使名称的长度合理化。

一般来说，超过32个字符的变量名在VGA显示器上读起来就困难了。

3.当使用缩略语时，要确保它们在整个应用程序中的一致性。

在一个工程中，如果一会儿使用Cnt，一会儿使用Count，将导致不必要的混淆。

回目录

八、代码注释规范

8.1代码注释约定

1.所有的方法和函数都应该以描述这段代码的功能的一段简明注释开始（方法是干什么）。

这种描述不应该包括执行过程细节（它是怎么做的），因为这常常是随时间而变的，而且这种描述会导致不必要的注释维护工作，甚至更糟—成为错误的注释。

代码本身和必要的嵌入注释将描述实现方法。

2.当参数的功能不明显且当过程希望参数在一个特定的范围内时，也应描述传递给过程的参数。

被过程改变的函数返回值和全局变量，特别是通过引用参数的那些，也必须在每个过程的起始处描述它们。

回目录

8.2模块头部注释规范

以一个物理文件为单元的都需要，例如﹕C#中包括cs檔

用于每个模块开头的说明，主要包括：

（粗体字为必需部分，斜体字为可选部分）

1.文件名称（FileName）：

此文件的名称

2.功能描述（Description）：

此模块的功能描述与大概流程说明

3.数据表（Tables）：

所用到的数据表，视图，存储过程的说明，如关系比较复杂，则应说明哪些是可擦写的，哪些表为只读的。

4.作者（Author）：

5.日期（CreateDate）：

6.参考文档（Reference）：

该档所对应的分析文档，设计文檔。

7.引用（Using）﹕开发的系统中引用其它系统的Dll、对象时，要列出其对应的出处，是否与系统有关﹙不清楚的可以不写﹚，以方便制作安装档。

8.修改记录（RevisionHistory）：

若档案的所有者改变，则需要有修改人员的名字、修改日期及修改理由。

R1:

修改作者:

修改日期：

修改理由:

R2:

修改作者:

修改日期：

修改理由:

R3:

…

R10

…

R100

9.分割符：

＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝（前后都要）

例图如下：

回目录

8.3方法注释规范

注意事项：

1.事件不需要头注解，但包含复杂处理时（如：

循环/数据库操作/复杂逻辑等），应分割成单一处理函数，事件再调用函数。

2.所有的方法必须在其定义前增加方法注释

3.方法注释采用///形式自动产生XML标签格式的注释

///

///

///

标记

说明

备注

提供了一种将说明中的文本标记为代码的方法

提供了一种将多行指示为代码的方法

可以指定使用方法或其他库成员的示例。

一般情况下，这将涉及到标记的使用。

对可从当前编译环境中获取的异常的引用。

得以引用描述源代码中类型和成员的另一文件中的注释。

用于定义表或定义列表中的标题行。

用于诸如