团队中，代码规范是一件很重要的约定，每一个人都应该去遵守，这样才可以写出大家都容易读懂的代码。本文列出了常用的代码标准规范与约定。 主要涵盖：
- 类名，变量名
- 常量，缩写
- 下划线，类型名
- 接口，文件名
- 命名空间
- 括号，枚举
类名
推荐：采用PascalCasing命名方式给类名和方法名, 同时采用名词或者名字短语组合。
public class ClientActivity
{
public void ClearStatistics()
{
//...
}
public void CalculateStatistics()
{
//...
}
}
public class Employee
{
}
public class BusinessLocation
{
}
public class DocumentCollection
{
}
理由：和.NET命名一致，易读。也很容易记住。
变量名
推荐：针对局部变量和方法参数采用camelCasing命名。
public class UserLog
{
public void Add(LogEvent logEvent)
{
int itemCount = logEvent.Items.Count;
// ...
}
}
理由：和.NET命名一致，易读。
标识符
不推荐：不要使用带有匈牙利标识符或者其他类型的前缀标识符。
// Correct
int counter;
string name;
// Avoid
int iCounter;
string strName;
理由：和.NET命名一致，易读。除此之外，Visual Studio中用Tooltips可以很容易知道一个变量的类型。最好不要加这样的类型缩写作为前缀。
常量
推荐：采用PascalCasing命名方式给常量，不要采用全部大写的方式。
// Correct
public static const string ShippingType = "DropShip";
// Avoid
public static const string SHIPPINGTYPE = "DropShip";
理由：和.NET命名一致，易读。全部大写容易引起过多的注意力，也不容易分辨出其中的单词组合。
缩写
推荐：一般情况下避免使用缩写，除非，缩写名是一个非常常用的名字，比如 Id, Xml, Ftp, Uri等。
// Correct
UserGroup userGroup;
Assignment employeeAssignment;
// Avoid
UserGroup usrGrp;
Assignment empAssignment;
// Exceptions
CustomerId customerId;
XmlDocument xmlDocument;
FtpHelper ftpHelper;
UriPart uriPart;
理由：和.NET命名一致，易读。同时可以避免不同的程序员写出不一致的缩写。
如果需要使用缩写，缩写名是3个或者以上的字符，采用PascalCasing命名方式，如果是两个字符，则全部大写。 像下面的： Html, Ftp, UI
HtmlHelper htmlHelper;
FtpTransfer ftpTransfer;
UIControl uiControl;
理由：和.NET命名一致，易读。大写视觉上可以吸引更好的注意。
下划线
推荐：不推荐在变量和方法中使用下划线，除非变量为局部变量。
// Correct
public DateTime clientAppointment;
public TimeSpan timeLeft;
// Avoid
public DateTime client_Appointment;
public TimeSpan time_Left;
// Exception
private DateTime _registrationDate;
理由：和.NET命名一致，易读。读这个变量更加自然，不需要去重音读下划线。
类型名
推荐：使用预定义的类型名而不是系统的真实类型名，比如：Int16, Single, UInt64等。
// Correct
string firstName;
int lastIndex;
bool isSaved;
// Avoid
String firstName;
Int32 lastIndex;
Boolean isSaved;
理由：和.NET命名一致，读起来更加自然。
隐含类型(var)
推荐：使用var针对局部变量，除非类型是基本的简单类型（int, string, double等）。
var stream = File.Create(path);
var customers = new Dictionary();
// Exceptions
int index = 100;
string timeSheet;
bool isCompleted;
理由：消除混乱，特别是复杂的泛型类型。类型很容易通过Visual Studio工具提示检测。
Interface
推荐：接口名词以字母I开头。采用名字或者是形容词。
public interface IShape
{
}
public interface IShapeCollection
{
}
public interface IGroupable
{
}
理由：和.NET命名一致，易读
文件名
推荐：文件名和内部主要的Class同名。除非这个是一个partialclass，那么以e.g. designer, generated, 等结尾。
// Located in Task.cs
public partial class Task
{
//...
}
// Located in Task.generated.cs
public partial class Task
{
//...
}
理由：和.NET推荐的实践一致。
命名空间
推荐：用一个清晰的结构去组织Namespace。比如采用：<公司名>.<产品>.<模块>.<子模块>。
// Examples
namespace Company.Product.Module.SubModule
namespace Product.Module.Component
namespace Product.Layer.Module.Group
理由：和.NET命名一致，同时也容易组织多模块或者组件的结构。
括号
推荐：采用垂直对齐的大括号
// Correct
class Program
{
static void Main(string[] args)
{
}
}
// NOT
class Program{
static void Main(string[] args){
}
}
单行代码也用{}包括进来。
// Correct
static void Add()
{
if(skip)
{
count = 0;
}
}
// NOT
static void Add()
{
if(skip)
count = 0;
}
成员变量
推荐：成员变量在Class文件的前面，Static的变量放在最前面
// Correct
public class Account
{
public static string BankName;
public static decimal Reserves;
public string Number {get; set;}
public DateTime DateOpened {get; set;}
public DateTime DateClosed {get; set;}
public decimal Balance {get; set;}
// Constructor
public Account()
{
// ...
}
}
推荐：一个通用的做法，这样可以快速从文件顶部找到所有的成员变量。
Enum
推荐：采用单数去定义枚举。特例是需要定义bit属性的枚举去按位与（OR）。
// Correct
public enum Color
{
Red,
Green,
Blue,
Yellow,
Magenta,
Cyan
}
// Exception
[Flags]
public enum Dockings
{
None = 0,
Top = 1,
Right = 2,
Bottom = 4,
Left = 8
}
- 不要显式的指定枚举的类型和枚举项的值
- 不要用enum作为后缀
// Don't
public enum Direction : long
{
North = 1,
East = 2,
South = 3,
West = 4
}
// Don't
public enum CoinEnum
{
Penny,
Nickel,
Dime,
Quarter,
Dollar
}
// Correct
public enum Coin
{
Penny,
Nickel,
Dime,
Quarter,
Dollar
}
理由：和.NET命名一致，读起来更加自然。复数形式的标记（比如Dockings)可以用按位与（OR)从而容易得出是哪个具体的Flag。