C#开发命名规范

时间:2022-06-04 12:40:26

学习C#之初,始终不知道怎么命名比较好,很多时候无从命名,终于有一天我整理了一份命名规范文档,自此我就是按照这个命名规范书写代码,整洁度无可言表,拙劣之处请大家斧正,愚某虚心接受,如有雷同,不胜荣幸

C#语言开发规范

作者ching

1.  命名规范

a) 类

【规则1-1】使用Pascal规则命名类名,即首字母要大写。

eg:

Class Test

{

...

}

【规则1-2】使用能够反映类功能的名词或名词短语命名类。

【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。

【规则1-4】自定义异常类应以Exception结尾。

eg:

Class TestException

{

...

}

【规则1-5】文件名要能反映类的内容,最好是和类同名。

b) 类字段(类成员)

【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。

【规则2-2】类字段变量名前可加“_”前缀。

【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。

eg:

Class Test

{

privatestring myName;

privatestring _myCoCo;

...

}

c)方法

【规则3-1】方法名采用Pascal规则,第一个字符要大写。

【规则3-2】方法名应使用动词或动词短语。

【规则3-3】类中访问修饰符或功能相同的方法应该放在一起, 且公共或实现接口的方法在前。

eg:

Class Test

{

...

publicvoid GetData(...)

{

...

}

privatevoid GetName(...)

{

...

}

privatestatic void GetCount(...)

{

...

}

}

d)属性

【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写

【规则4-2】属性和相应字段名称要关联, 可以使用“重构”菜单来生成属性。

eg:

Class Test

{

private string myName;

public string MyName

{

set

{

myName = Value;

}

get

{

return myName;

}

}

}

e)参数

【规则5-1】参数采用camel规则命名,且首字符小写。

【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。

【规则5-3】不要给参数加匈牙利语类型表示法的前缀。

【规则5-4】检查方法所有输入参数的有效性。

eg:

ClassTest

{

public void GetData(string name,string strFlag)

{

...

}

}

f)常量

【规则6-1】只读常量使用Pascal命名规则,即首字母大写。

【规则6-2】枚举名使用Pascal规则命名,枚举成员本质属于常量,命名规则同上。

【规则6-3】枚举值从小到大顺序定义。

【规则6-4】静态字段或属性采用Pascal规则,即首字符大写。

eg:

ClassTest

{

public const double Pi = 3.14159365753;

private readonly double Pai = 3.14159365753;

}

g)接口

【规则7-1】接口定义使用Pascal规则,且必须以大写“I”开头。

【规则7-2】接口名称要有意义,中间不要有下划线“_”等字符。

【规则7-3】如果类实现了接口,名称尽量和接口相同, 只是省掉“I”字符。

eg:注意这里的接口修饰符只能用public和internal

interfaceITest

{

...

}

h)事件

【规则8-1】委托名称采用Pascal规则,即首字符大写。

【规则8-2】定义事件的委托要使用EventHandler后缀,且包括sender和e两个参数。

【规则8-3】事件用到的参数,名称要带EventArgs后缀。

eg:

ClassTest

{

private delegate void DoTask();

private event DoTask DoTaskEventHandler;

private event DoTask DoTaskEventHandler(Object sender,EventArgse);

private event DoTaskDoTaskEventHandler2(string   strEventArgs)

{

...

}

...

}

i) 命名空间

【规则9-1】命名空间名称采用Pascal规则,且首字符大写。

【规则9-2】命名空间名称尽量反映其内容所提供的整体功能。

eg:

namespace MyTest

{

ClassTest

{

...

}

...

}

2.  注释规范

a)文件头部注释

【规则1-1】文件都包含文件头, 要说明文件名、作者、创建时间、变更记录。

【规则1-2】推荐采用.NET形式书写头部注释。(待考查)

b)类及其成员注释

【规则2-1】对方法和类使用“///”三斜线注释。

【规则2-2】代码行文注释采用“//”和“/**/”进行,应该尽量说明问题。

3.行文规范

a)缩写规范

【规则1-1】标识符应当直观可望文知意,不提倡使用任何缩写。

【规则1-2】字符串变量推荐是用“str”或“s”开头,采用string.Empty来初始化。

【规则1-3】普通对象可以以“obj”开头。

【规则1-4】缩写可自行定义,一般取单词的前/后字符组成,以含义直观为准则。

【规则1-5】一般情况下不要让缩写破坏标识符的含义。

b)排版

【规则2-1】每行语句至少占一行,如果语句过长(超过一屏),则该语句断为两行显示。

【规则2-2】把相似的内容放在一起,比如字段、属性、方法、事件等,使用“#region--#endregion”命令分组。

【规则2-3】多个程序元素进行对等操作时, 操作符之前、之后或者前后都要加空格。

【规则2-4】每个方法的源程序行数原则上应该少于200行。(如果超过过多,则需要另写一方法)

【规则2-5】语句嵌套层次不得超过3层。

【规则2-6】避免相同的代码段在多个地方出现。(尽量避免代码重复,能复用则复用)

c)语句结构

【规则3-1】如果使用了异常结构,一定要处理异常, 一般是要写日志文件。

【规则3-2】分支语句不应该使用复杂长条件, 应该将长条件封装成方法。

【规则3-3】switch语句,case后面必须接break。

【规则3-4】禁止使用goto语句进行跳转。

【规则3-5】行文中严禁出现“魔数”,特定含义的常数必须定义成枚举或常量。

【规则3-6】不同类型的操作符混合使用时,使用括号给出优先级。

【规则3-7】不允许使用复杂的操作符组合等。

【规则3-8】循环、判断语句的程序块部分用花括号括起来, 即使只有一条语句。(return;待议)

【规则3-9】在switch语句中总是要有default字句,建议使用断言。

【规则3-10】每个类和方法完成单一的功能,不设计多用途面面俱到的类或方法。

【规则3-11】严禁使用未经初始化的变量,变量通常使用构造方法来初始。

d)代码缩进

【规则4-1】碰到大括号要换行。

【规则4-2】不允许使用Java中的括号换行规范。

e)大小写

【规则5-1】不要创建名称相同,但大小写区别的任何元素。

【规则5-2】应当大写仅有两个字符的缩写。(如果只有两个字符,则都大写)

【规则5-3】不要把易混淆的数字和字符放在一起。

【规则5-4】使用英文命名标识符。

f)重名规范

【规则6-1】不允许变量名、类名、属性名、 方法名等与系统标识符重名。(系统标识符见附表)

g)SQL编码规范

【规则7-1】SQL语句全部大写。(本人的习惯是小写,为了性能,最好是大写,我自己也得把习惯改改咯,哈哈哈)

【规则7-2】对较为复杂的SQL语句加上注释,说明其功能。

【规则7-3】连接符OR、IN、AND、以及=、<=、>=等前后加空格。

【规则7-4】使用明确的列代替 SELECT *。

h)软件架构

【规则8-1】数据库中每一张表对应一个实体类/数据传输对象(DTO)。

【规则8-2】实体类名称使用表名,也可带有Dto后缀。

【规则8-3】三层架构应当合理使用,不应生搬硬套。

【规则8-4】三层架构元素推荐使用后缀:

数据传输对象         XxxxDto

DAO工厂            XxxDAOFactory

DAO接口            IXxxxDAO

服务接口           IxxxxService

DAO的数据库实现     XxxxDAOOracle/XxxxDAOInfomix

业务逻辑           XxxxManager

i)系统

【规则9-1】在我国内不建议随便使用设计模式等代码模式,因为并不流行。

【规则9-2】系统输入、资源操作(如内存分配、文件及目录操作)、网络操作(如通信、调用等)、任务间的操作(如通信、调用等)时必须进行错误、超时、或则异常处理。

【规则9-3】模块的编写应有完善的测试方面的考虑。

附表

表1 各种类型命名规范总结

类型

命名规则

注意事项

实例

类或结构

Pascal

首字符大写

HttpContext

接口

Pascal

加前缀I

IDataAdaper

枚举名

Pascal

首字符大写

CommandType

枚举值

Pascal

首字符大写

CommandType.Text

事件

Pascal

首字符大写

SelectedIndexChanged

自定义异常

Pascal

加后缀Exception

ArgumentException

类公共字段

Pascal

首字符大写

MaxValue(或_MaxValue)

方法

Pascal

首字符大写

ToString()

命名空间

Pascal

首字符大写

System.Xml

属性

Pascal

首字符大写

BackColor

保护或私有字段

Camel

首字符小写

myVariable

参数

Camel

首字符小写

cmdText

表2 数据类型缩写规则

数据类型

数据类型缩写

标准命名实例

Bool

b/is

IsVisable

Float

F

FPrice

Double

D

DPrice

Unit

U

UAge

Int

I

INumber

Char

Ch

ChCode

Byte

Bt

BtImages

String

Str

StrName

Struct

St

StStudent

Window

Wnd

WndMain

ArrayList

Lst

LstStudents

Array

Arr

ArrStudents

Hashtable

Ht

Htstudents

表3 Windows控件缩写规则

控件类型

控件名称

控件类型缩写

实例

Label

标签框

Lbl

LblMessage

LinkLabel

超链接标签框

Llbl

LlblToday

Button

按钮

Btn

BtnSave

TextBox

文本框

Txt

TxtName

MainMenu

菜单栏

Mmnu

MmnuFile

CheckBox

多选框

Chk

ChkStock

RadioButton

单选框

Rbtn

RbtnSelected

GroupBox

组合框

Gbx

GbxMain

PictureBox

图片框

Pic

PicImage

Panel

Pnl

PnlBody

DataGrid

Dgrd

DgrdView

ListBox

Lst

LstProducts

CheckedListBox

Clst

ClstChecked

ComboBox

组合框

Cbo

CboMenu

ListView

列表视图

Lvw

LvwBrowser

TreeView

树视图

Tvw

TvwType

TabControl

Tctl

TctlSelected

DateTimePicker

Dtp

DtpStartDate

HscrollBar

Hsb

HsbImage

VscrollBar

Vsb

VsbImage

Timer

Tmr

TmrCount

ImageList

Ilst

IlstImage

ToolBar

工具栏

Tlb

TlbManage

StatusBar

状态栏

Stb

StbFootPrint

OpenFileDialog

Odlg

OdlgFile

SaveFileDialog

Sdlg

SdlgSave

FoldBrowserDialog

Fbdlg

FbdlgBrowser

FontDialog

Fdlg

FdlgFoot

ColorDialog

Cdlg

CdlgColor

PrintDialog

Pdlg

PdlgPrint

表 4 数据库对象缩写规范

数据库对象

名称

简写

实例

Connection

Con

ConNorthwind

Command

Cmd

CmdReturnProducts

Parameter

Parm

ParmProductID

DataAdapter

Dap

DapProducts

DataReader

Dtr

DtrProducts

DataSet

Ds

DsNorthwind

DataTable

Dt

DtProduct

DataRow

Drow

DrowRow

DataColumn

Dcol

DcolProductID

DataRelation

Drl

DrlMasterDetail

DataView

Dvw

DvwFilteredProducts

原文转自:http://blog.csdn.net/chenhongwu666/article/details/35354247
原作者为 ching126。请尊重原作者版权

C#开发命名规范的更多相关文章

  1. java开发命名规范(转载)

    java开发命名规范 使用前注意事项: 1.  由于Java面向对象编程的特性, 在命名时应尽量选择名词 2.  驼峰命名法(Camel-Case): 当变量名或函式名是由一个或多个单字连结在一起,而 ...

  2. 你不可不看的Android开发命名规范

    标识符命名法最要有四种: Camel(骆驼)命名法:除首单词外,其余所有单词的第一个字母大写,如:fooBar; Pascal命名法:所有单词的第一个字母大写,如:FooBar: 下划线命名法:单词与 ...

  3. 我自己总结的C&num;开发命名规范整理了一份

    我自己总结的C#开发命名规范整理了一份 标签: 开发规范文档标准语言 2014-06-27 22:58 3165人阅读 评论(1) 收藏 举报  分类: C#(39)  版权声明:本文为博主原创文章, ...

  4. SSH框架项目开发命名规范

    SSH 框架项目开发命名规范   一.各层包及类命名规范   总体原则:包名所有字母小写,类名采用 "驼峰标识",具体如下:   1. Action 类      包命名规范:co ...

  5. java开发命名规范总结

    一 包名的书写规范 (Package)推荐使用公司或机构的*域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性.包名全部为小写字母,且具有实际的区分意义. 1.1 一般要求1.选择有意义 ...

  6. 【转】android 开发 命名规范

    原文网址:http://www.cnblogs.com/ycxyyzw/p/4103284.html 标识符命名法标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外, ...

  7. 【转载】Android 开发 命名规范

    原文地址:http://www.cnblogs.com/ycxyyzw/p/4103284.html 标识符命名法标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外, ...

  8. android 开发 命名规范

    标识符命名法标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写. 2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字 ...

  9. Android 开发 命名规范(基础回顾)

    标识符命名法标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外,其余所有单词的第一个字母大写. 2 帕斯卡(pascal)命名法:又称大驼峰命名法,所有单词的第一个字 ...

随机推荐

  1. 利用typescript使backbone强类型智能提示

    模型类一旦多了没有强类型和智能提示是相当痛苦的,所以. 仅仅用ts定义一个模型类: class Person extends Backbone.Model { defaults = { Name:&q ...

  2. thinkphp分页搜索条件带中文参数

    /** * 中文处理 * @param type $str * @return str * $author lxh */ function url2word($str){ $sub=strpos($s ...

  3. C&plus;&plus;访问sqlite3实践

    Sqlite确实是一个比较好的本地数据库,从接触它的时候就喜欢上了它,它可以在很多情况下简化应用.不过以前都是在Java里面使用,或者Linux C下使用的,现在有个项目(C++)可能我会用到sqli ...

  4. Linux企业级开发技术(6)——libevent企业级开发之内存管理

    默认情况下,libevent使用C库的内存管理函数在堆上分配内存.通过提供malloc.realloc和free的替代函数,可以让libevent使用其他的内存管理器.希望libevent使 用一个更 ...

  5. Delphi 把字符串读到流中的操作。

    var FReQuestM := TMemoryStream FReQuestM.Write(PChar(FcVoucherXML)^, Length(FcVoucherXML)); 这样就读到流中了 ...

  6. 以Crypto&plus;&plus;实现RSA加解密二进制数据

    网上一大片讲怎么加解密字符串的,找了大半天也没找到讲加解密二进制数据的,于是自己研究了下,分享给大家. 加解密函数: #include <rsa.h> #include <randp ...

  7. tomcat https jks 沃通免费证书安装 解决方案

    网上百度了一天什么没百度到,最后谷歌到了一篇文章启发之下解决之. 代理谷歌网站推荐一个,可以直接上谷歌: https://www.yundou.info ----------------------- ...

  8. Android 主线程和线程之间相互发送消息

    通过分析Activity源码,我们知道每个Activity都有一个Looper,所以主线程在接收Message是不需要调用Looper.prepare()和Looper.loop(),但是线程是不带L ...

  9. EC读书笔记系列之9:条款16、17

    条款16 成对使用new和delete时要采取相同形式 记住: ★若你在new表达式中使用[ ],必须在相应的delete中也使用[ ],反之亦然 -------------------------- ...

  10. iOS 加载Image的两种方式

    Apple官方文档对于加载image提供了两个方法 + (nullable UIImage *)imageNamed:(NSString *)name; + (nullable UIImage *)i ...