分享
 
 
 

C#简单命名指南

王朝c#·作者佚名  2006-11-24
窄屏简体版  字體: |||超大  

一个好的名字能够让你的程序更加好懂,别人一看到这个名字,就能够猜到你在做什么。大量好的名字离不开好的命名规范,而一个好的命名规范要做到两点:

l 合理。即容易被大家接受和使用。从这个意义上来说,好的命名规范不应该太长,它应该让你花上10分钟就能看完,写过几段代码就能熟悉。

l 风格一致。即前后一致,例外的情况少。

符合以上两点的命名规范就是好的,虽然它们具体的规则可能不同。有的时候,命名规范体现了编程思想,比如:对于接口,在.NET中,一般要求以“I”开头,在Java中没有这个要求,原因是Java认为接口和抽象类往往可以转化,比如:在项目初期,可能定义的是接口,而在后面,可能把它改成抽象类,如果名称一致,就避免了名称的改动。

另外,不同的命名规范也体现了程序发展历程。比如:匈牙利命名法要求类型前缀,故在C++、VB、PB一般都会大量出现类型前缀,像intAmount, strName等。而现在一般没有这个要求,原因是:1)有些类型可能会做修改,比如Int16变成Int32。另外对于一些动态语言(Python、JavaScript)来说,其类型是变化的,编译时无法确定;2)现在的开发环境更加的友好,即使在开发的时候,你也很容易知道变量的类型(只要鼠标移上去)。

本文的命名规范主要基于微软的标准,另外加上实际开发的一些具体经验。它还在不断的维护和完善,你可以针对不同项目的要求,做相应的调整。

命名样式

样式分类

名称

解释

适用环境

例子

Pascal 大小写

首字母和后面的每个单词的首字母都大写;其他字母小写

BackColor

Camel 大小写

首字母小写,而后面的每个单词的首字母大写;其他字母小写

backColor

大写

所有字母都大写

l 缩写。

l 少于等于2个字符

System.IO

System.Web.UI

样式的选择

标识符

命名格式

例子

备注

参数、局部变量

Camel

public int GetTypeID(string typeName)

{ int typeID; … }

Private、Protected的实例字段

Camel

private string redValue;

protected bool isOk;

界面控件

Camel

private Label lblAlarm;

缩写

大写

namespace System.IO

{ … }

缩写必须是被普遍接受、众所周知的缩写。

除上面的标识符外

Pascal

public System.Drawing.Color BackColor

{ … }

原则和习惯

首要原则

有意义的,描述性的词语来命名。能够一眼看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了

1. 除约定俗成的,别用缩写。用name, address, salary等代替 nam, addr, sal

2. 除用于循环,别使用单个字母的变量象i, n, x 等. 而要使用 index, temp等。

for ( int i = 0; i < count; i++ ){ ...}

其他习惯

l除了界面控件外,不要使用类型前缀。比如:使用名称amount,而不是 intAmount;

l类:使用名词、名词短语命名。比如:public class FileStream;

l方法:使用动词、动词短语开始。比如:CreateUser(), RemoveAt()等;

l接口:以 I 开始,后面加上名词、名词短语、形容词命名。比如:IDisposable;

l常量:所有单词大写,多个单词之间用 "_" 隔开。public const string PAGE_TITLE = "Welcome";

l命名空间:

1.基本格式:

CompanyName/ProjectName.TechnologyName[.Feature][.Design]

a)CompanyName/ProjectName:公司名、项目名称或产品名称;

b)TechnologyName:稳定的、公认的技术名称或架构层次名称;

c)[.Feature][.Design]:可选的功能与设计;

例如:

//微软公司的Web开发中的UI中的Design

namespace Microsoft.Web.UI.Design

//西门子报价项目中业务逻辑层中的项目管理

namespace SiemensQuotation.BusinessRules.ProjectManagement

2.几个规则

a)嵌套的命名空间应当有依赖关系。例如:System.Web.UI.Design 中的类依赖于 System.Web.UI 中的类,而不能相反。

b)命名空间和类不能使用同样的名字。例如,命名空间Debug下最好不要又一个类名为Debug。

c)如果公司名、项目名称或产品名称太长的话,可以用缩写(且全部大写)。

控件命名控件的名称中需要加上前缀,之所以这样做是为了区分界面的控件和普通的对象,由于界面修改往往非常频繁,区分开来能使你更快速的找到控件,从而修改界面。举一个例子:

界面有10个TextBox、10个Label。一个TextBox对应一个Label,为了完成读写,你至少要有20条语句来从控件进行取、赋值操作,如果有前缀的话,输入this.txt,你就几乎马上能找到这个控件。反之,如果没有前缀,由于窗口或页面对象拥有大量的属性和变量(>100个),你将花费大量时间来查找。另外一个TextBox对应一个Label(一个代表值,一个代表名称),它们往往指同一样事物,如果有前缀,就很容易区分这两个控件。

控件

前缀

备注

Label

lbl

比如:lblName

TextBox

txt

Button

btn

CheckBox

chk

RadioButton

rdo

CheckBoxList

chklst

RadioButtonList

rdolst

ListBox

lst

DropDownList

ddl

DataGrid

dg

DataList

dl

Image

img

Table

tbl

Panel

pnl

LinkButton

lnkbtn

ImageButton

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有