.NET命名规范和开发约定
一个新团队的组建,规范是个很大的问题,特别对于刚毕业的学生,需要加强一下这方面的学习和训练。上个星期给我们新来的同事讲解了一下.NET编程规范,顺便也回顾一下编程规范。由于前期没有太多的准备,而且公司没有这方面的文档,今天记下留着备用以便整理成文档给与后来者使用,这些都只是在下多年来使用的一些约定,可能是错误的或不对,欢迎各位批评指正。
命名规范:
有3种最常见的命名规范,大部分编程规范的命名法则都来自于他们。他们是:
- 匈牙利命名法:也就是Hungarian 命名法。这种命名技术是由一位能干的Microsoft程序员查尔斯·西蒙尼(Charles Simonyi) 提出的,他出生在匈牙利。就被命名为“匈牙利命名法”,主要用于Window系统编程。
- Camel命名法:也叫骆驼命名法。原因是采用该命名法的名字看起来就像骆驼的驼峰一样高低起伏。首字母小写例如:string myAddress;主要非Public的使用此方法。
- Pascal命名法:也叫帕斯卡命名法。首字母大写的命名法则。例如 string MyAddress;
.NET命名规范:
在.net编程过程中,一般采用Camel和Pascal命名方法结合的方式来命名。
类 |
Pascal |
AppDomain |
枚举类型 |
Pascal |
ErrorLevel |
枚举值 |
Pascal |
FatalError |
事件 |
Pascal |
ValueChanged |
异常类 |
Pascal |
WebException |
只读的静态字段 |
Pascal |
RedValue |
接口 |
Pascal |
IDisposable |
方法 |
Pascal |
ToString |
命名空间 |
Pascal |
System.Drawing |
参数 |
Camel |
typeName |
属性 |
Pascal |
BackColor |
一般遵循上面的命名约定就可以写出比较好看的代码了。当然最团队开发中还需要注意的是对Public和Protected方法属性等等进行注释,代码的美化有助于阅读,而且多个成员之间可以一目了然的看到了方法或其他的使用情况。
C#文档布局
一般情况下一个C#文件首先需要添加的是版权,开发者,开发日期等等信息,这个可以通过注册class模板实现,而不需要一个一个的添加和改写。
/***************************************************************
*
* 缓存实例。
*
* 最后修改:2011-10-28
* ************************************************************/
namespace MyNamespace
{
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
class MyClass{}
}
当然可以把引用的命名空间写到前面去,只不过我比较喜欢放在里面。我们团队的开发人员我一般都会帮他们注册一个class模板,所以每次添加的类基本都是这样的,关于如何添加可以查看我博客的另一篇文章:
VS2010类模板更改,增加版权等等信息
数据库方法的命名约定
对于一个实例来说,SQL语句一般只有四个,Insert Into, Delete From, Select From, Update Set。我一般会要求团队成员们使用Create, Delete, Get/Load, Update,当然如果方法同时都可以有Insert和Update,也可以使用CreateOrUpdate/Save来表示。方法名称使用动宾词语格式,如果是多个集合的使用复数形式。
最后还会鼓励使用枚举来替代各种数字等等表示的特性,使用const常量来替代经常出现的字符串,这样在修改时候就不需要每个地方替换了。而且使用枚举会更佳直观提供代码阅读性,好久没写博客了,都不知道怎么写,要写些什么了,今天来亮相一下,欢迎各位批评指正!!!