net 程序设计命名规范

一、程序集和动态链接库(DLL)的命名

程序集是一个部署单元,一般来说一个程序集仅与一个DLL对应。命名空间和DLL和程序集不是一个概念,命名空间一般来说是一个逻辑实体而DLL和程序集是用于打包和部署的一个单元,一个DLL可以包含多个命名空间,一般将DLL命名为System.Net 不一定命名空间也为System.Net。

首先、要为程序集或者DLL选择具有代表性的名字命名,比如:System.Net,一眼就能看出它的大致用途。这样的命名才是最合适的,才具有实际的意义。如果我们的命名不能很好的表达它具体的功能那么就需要重新考虑更改命名了,因为不能很好表达出具体功能的命名我认为就是失败的不合适的,因为这样的命名并没有给你带来任何好处反而让程序变得很混乱不之所云。

其次、推荐一种命名结构,即使用“公司名称/机构名称”+“.”+“组件名称”+”.”+”dll”的方式来命名。因为这样会使结构更清晰。

二、命名空间的命名

首先、命名空间要采用PascalCasing大小写风格,各部分用“.”隔开。

其次、要尽量使用“公司名称”为前缀,然后加组件描述名称,因为这样不会与其他第三方命名相冲突。

三、接口的命名

接口在实际工作中是我们经常接触到的,它是一种约束一种抽象,对于它的命名一般采用微软的命名习惯即:“I”+具体功能的描述。这种命名已经被大多数开发人员接受,一看见以大写I开头一般都会认为是接口。需要注意的是I后面的命名采用PascalCasing大小写风格并采用形容词有时也可以是名词来命名,如:ICollection。

四、类和结构的命名

类和结构一般采用PascalCasing大小写风格,采用名词或名词短语来命名。

不要为类名加前缀,比如“C”。

考虑在派生类结尾采用基类名称。

五、枚举类型的命名

这个也是目前我们公司争议最大的地方,有些人认为加“Enum”前缀或者后缀会更好一些,这样一眼就能确定它是枚举类型,还有一部分人认为应该墨守微软的陈规不应该加”Enum”的前缀或者后缀。公所公有理,婆说婆有理,最终我们目前采用的是“Enum”前缀命名方式。(少数服从多数吧)

枚举采用PascalCasing大小写风格。

六、方法的命名

采用PascalCasing大小写风格。

采用动词或者动词短语来命名方法。

七、属性的命名

采用PascalCasing大小写风格。

采用名称或者形容词来命名属性。

要采用项目短语的复数形式来命名集合属性。

要有肯定性的短语来命名布尔属性如:CanRead。

八、事件的命名

要采用PascalCasing大小写风格。

要采用动词或者动词短语的时态来表示事件发生时间。

要在处理函数加“EventHandler”后缀。

要在事件处理函数中采用“sender”“e”作为两个参数的名字。

要在命名时间参数时加“EventArgs”后缀。

九、字段的命名

采用Pasca大小写风格。

用名词、名称短语或者形容词来命名字段。

不要为字段加前缀。

十、参数的命名

采用camelCasing大小写风格。

要使用具有描述性的参数名称。

时间: 2024-12-20 18:25:25

net 程序设计命名规范的相关文章

C++、Java与C#的命名规范总结

序言 由于在开发工作中经常用到C++.Java和C#作为开发语言,命名规范的问题经 常给我造成一些困扰.一方面命名规范没有唯一的标准答案,另一方面,虽说语 言的命名规范并没有固定的形式,三种语言的风格毕竟不太一样,也各自有着一 些独特的特点.在编写代码的过程中所采用的命名方式经常变动,没有形成固定 的风格.因此,根据从网上收集到的一些资料以及自身的一些经验,对C++. Java以及C#的命名规范进行了总结,方便以后查询. 命名规范的原则: l 尽量采用以前采用过的命名规则: l 尽量在三种语言下

软件命名规范(版本号)

软件命名规范 软件版本阶段说明 Base版: 此版本表示该软件仅仅是一个假页面链接,通常包括所有的功能和页面布局,但是页面中的功能都没有做完整的实现,只是做为整体网站的一个基础架构. Alpha版: 此版本表示该软件在此阶段主要是以实现软件功能为主,通常只在软件开发者内部交流,一般而言,该版本软件的Bug较多,需要继续修改. Beta版: 该版本相对于α版已有了很大的改进,消除了严重的错误,但还是存在着一些缺陷,需要经过多次测试来进一步消除,此版本主要的修改对像是软件的UI. RC版: (Rel

第2章番外 Java的命名规范

Java开发者对Java的代码风格有自己的规范,良好的代码风格是非常重要的.下面来说下各种命名规范: 包命名(全小写,反写域名) Java引入包的机制很大程度是为了解决重名问题,这有点想C++的命名空间的作用. 包实际上提供了一种命名机制和可见性机制. 为了最大程度地防止重名,包名必须具有唯一性. Java包的名字都是由小写单词组成.但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在

Swift常量和变量以及命名规范

我们在上一章中介绍了如何使用Swift编写一个HelloWorld小程序,其中就用到了变量.常量和变量是构成表达式的重要组成部分.常量在声明和初始化变量时,在标识符的前面加上关键字let,就可以把该变量指定为一个常量.顾名思义,常量是其值在使用过程中不会发生变化的量,实例代码如下:let_Hello = "Hello"_Hello标识符就是常量,只能在初始化的时候被赋值,如果我们再次给_Hello赋值,代码如下:_Hello = "Hello, World"则程序会

网站文件命名规范

规范  · 文件命名的原则:以最少的字母达到最容易理解的意义.· 索引文件统一使用index.html文件名(小写) index.html文件统一作为"桥页",不制作具体内容,仅仅作为跳转页和meta标签页.主内容页为main.html · 按菜单名的英语翻译取单一单词为名称.例如: 关于我们 \aboutus 信息反馈 \feedback 产 品 \product 所有单英文单词文件名都必须为小写,所有组合英文单词文件名第二个起第一个字母大写: 所有文件名字母间连线都为下划线 · 图

CSS布局命名规范

CSS布局命名规范 说明:均为class,需要扩展,则在当前命名内以"_"(下划线)后缀自定名称.我习惯称列表页为list,新闻列表则为newslist,图片列表为piclist,内容页为view,/**/整体大框架:#wrapper大框架内:#inwrapper/////////////////////////////////////////////////////////////////////////////////////////////////////////顶部及banne

网页制作 谈谈CSS样式表的命名规范

css|规范|网页|样式表 最近和一程序员合作项目.弄的我头都大了~埋怨我的CSS命名看不懂~得按照他的来.结果我打开他的页面,看了看,从头第一个开始就是contentCommon,下面全部是content****. 我说明了我的理由,过了半会,似乎是接受了,却突然来一句:"不要用H标签嘛!还有不要用UL来定义导航等".对于很多合作过的程序员,大多都是这样,命名规范大多是自成一派.对于制作标准更是视而不见.抱着只照顾IE正常浏览的态度叫嚣着"让FIREFOX和SAFARI见鬼

网页制作教程:CSS 命名规范

css|规范|教程|网页 XHTML-CSS写作建议 所有的xhtml代码小写 属性的值一定要用双引号("")括起来,且一定要有值 每个标签都要有开始和结束,且要有正确的层次 空元素要有结束的tag或于开始的tag后加上"/" 表现与结构完全分离,代码中不涉及任何的表现元素,如style.font.bgColor.border等 <h1>到<h5>的定义,应遵循从大到小的原则,体现文档的结构,并有利于搜索引擎的查询. 给每一个表格和表单加上一

数据库对象命名规范

对象|规范|数据|数据库 数据库命名规范  数据库命名规范 一.实体和属性的命名1. 常用单词已经进行了缩写,在命名过程当中,根据语义拼凑缩写即可.注意,由于ORCAL数据库会将字段名称统一成大写或者小写中的一种,所以要求加上下划线举例:定义的缩写 Sales: Sal 销售:Order: Ord 订单:Detail: Dtl 明细:则销售订单名细表命名为:Sal_Ord_Dtl;2. 如果表或者是字段的名称仅有一个单词,那么建议不使用缩写,而是用完整的单词.举例:定义的缩写 Material