对C#.NET编程规范的个人见解
对C#.NET编程规范的个人见解
作者:Eunge
邮箱:eudev.net@yeah.net
我们应该知道编程规范对于项目的生命周期多么重要,如果每个程序员写的代码都令其他人难以阅读、或者一个团队项目的代码却五花八门,这样的项目将会是怎么样的噩梦。
MS为提供了FXCop工具,用于自动检查代码的规范性、安全性和效率,所以,本文将围绕MS提供的C#.NET代码规范展开。
FXCop工具下载地址:http://www.gotdotnet.com/team/fxcop
1、命名约定
Pascal和Camel命名约定
编程的命名方式主要有Pascal和Camel两种(Pascal:每个单词的首字母大写,例如ProductType;Camel:首个单词的首字母小写,其余单词的首字母大写,例如productType)
以下是一些常用的C#成员及其推荐命名方法:
标志符
规则
实例与描述
类class
Pascal
Application
枚举类型enum
Pascal
记住,是以Pascal命名,切勿包含Enum,否则FXCop会抛出Issue
委托delegate
Pascal
以Pascal命名,不以任何特殊字符串区别于类名、函数名
常量const
全部大写
全部大写,单词间以下划线隔开
接口interface
Pascal
IDisposable 注:总是以 I 前缀开始,后接Pascal命名
方法function
Pascal
ToString
命名空间namespace
Pascal
以.分隔,当每一个限定词均为Pascal命名方式,比如:
using ExcelQuicker.Framework
参数