标签：
一、文件命名
1 文件名
文件名统一使用帕斯卡命名法，以C#类名命名，拓展名小写。
示例：
GameManager.cs
2 文件注释
每个文件头须包含注释说明。
示例：
// 文件名：GameStatusMachine.cs
// // 文件功能描述： // // 游戏状态机基类脚本，用于读写全局游戏状态，发送游戏状态以调控游戏场景切换等 // // 创建标识：taixihuase 20150327 // // 修改标识：taixihuase 20150328 // 修改描述： // 在游戏状态枚举GameStatus中添加枚举值LoginStatus，表示登录状态 // // 修改标识： // 修改描述： //
文件头注释遵循以下规则。
规则1：文件头注释中的文件功能仅需简述。
规则2：创建标识或修改标识由创建者或修改者及日期组成。
规则3：同一天内同一个人多次对文件修改只需做一个修改标识，同一天内不同人对文件进行修改则需另做一个修改标识。
规则4：注释统一用双左斜杆，不要用C风格注释，避免杂乱注释如一行星号填充空位，保持注释整洁
规则5：必要时，在多项注释内容段之间使用内容为空的注释，而非使用空行
二、代码风格
1 列宽
编写代码时切换到屏幕高分辨率，以1440*900分辨率下Visual Studio 2013为例，在代码缩放为100%时，代码控制在110列以内。
2 换行
当表达式超出或即将超出列宽时，遵循以下换行规则。
规则1：在操作符前换行。
规则2：在逗号后换行，优先于规则1。
规则3：使用IDE自带的换行，而非手动换行，此规则优先级最高。
3 缩进
每行开头使用一个Tab，占4个字符长度。不要直接敲入4个空格，而应使用Tab键。但不能使用Tab制表符，而应在IDE中设置缩进大小为4，以及转换Tab。以Visual Studio 2013为例，方法如下：
工具->选项->文本编辑器->C#->制表符->插入空格
4 空行
使用空行将逻辑相关的代码进行分块，提高代码的可阅读性。
空行的使用遵循以下规则。
规则1：在类以上级别之间使用两个空行。
1. 接口与接口、类与类、接口与类的定义之间。
2. 枚举与接口、枚举与类的定义之间。
3. 命名空间与命名空间之间。
规则2：在类内级别之间使用一个空行。
1. 变量与变量、方法与方法、属性与属性、方法与属性、方法与字段之间。
2. 变量声明与语句之间。
3. 方法中不同逻辑块之间。
4. 方法中返回语句与其他语句之间。
5. 属性与跟该属性不相对应的字段之间。
6. 注释与其他由多条非注释语句组成、共同处理某一逻辑的代码段之间。
规则3：在类内紧密关联内容之间不使用空行。
1. 注释与其他注释之间。
2. 属性与跟该属性相关联的字段之间。
3. 注释与跟该注释对应的字段、属性、方法、接口、类及命名空间。
示例：
// 这是一个C#代码规范命名空间 namespace CSharpStyleGuide { // 这是一个接口 interface INothing { void Nothing(); } // interface INothing
// 这是第一个示例类 class FirstSampleClass { private static string className = "FirstSampleClass"; private int property; // 这是一个私有字段，这里用了行尾注释允许的两种情况之一，另一种与右括号关联 public int Property { get { return property; } set { property = value; } } public int AnotherProperty { get; set; } // 默认构造函数 // 带一个缺省参数value，默认值为0 FirstSampleClass(int value = 0) { Property = value; } public int GetValue() { // 显示提示信息 Console.WriteLine("这个类的类名为" + className); Console.WriteLine("这个类存储的值大小为："); // 单行显示值 Console.WriteLine(Property); return Property; } public virtual void SetValue(int value) { this.Property = value; } } // class FirstSampleClass // 在这个类内设置主方法入口 class Program { static void Main(string[] args) { // 暂时不做任何事 } } // class Program } // namespace CSharpStyleGuide
5 空格
优先使用IDE自带的缩进功能来填补空格，空格遵循以下规则。
规则1：关键字及左括号之间用空格隔开。
示例：
while (true)
规则2：方法名与左括号之间不使用空格。
示例：
ShowSample();
规则3：多个参数用逗号隔开，每个逗号后添加一个空格。
示例：
CompareValue(lhs, rhs);
规则4：除了.和->之外，二元运算符与其操作数之间用空格隔开，一元运算符不用空格隔开。
示例：
a += b; a = a / (a + b); a++;
规则5：语句中的表达式用空格隔开。
示例：
for (int i = 0; i < 100; ++i)
规则6：注释左斜杆后与注释的内容之间用空格隔开
示例：
// 这句注释前有个空格
6 括号
圆括号：使用圆括号首先需遵循使用空格的规则，其次，在没有必要的情况下，不要在return语句使用圆括号。
示例：
return ERROR;
花括号：使用时遵循以下的要求。
规则1：左花括号放在关键字或方法名的下一行并与之对齐。
规则2：左花括号与右花括号对齐。
规则3：花括号单独成行，不与任何语句并列一行。
规则4：if、else、while、do等语句后必须使用花括号，即使内部为空或仅有一条语句，这样便于扩展内容和快速搜索。
规则5：当代码块较长（将近或者超出一屏幕），此时建议在右花括号后添加注释，以便于找到对应的入口条件，注释与右花括号之间空出一格
示例：
while (true) { if (isOk) { return OK; } else { // Do Somthing here. return ERROR; } // isOK is False } // true
标签：
原文地址：http://www.cnblogs.com/taixihuase/p/4373473.html
