C#开发的一些规范
一、注释部分
1、文件的注释
/////////////////////////////////////////////////////////////////////
// 工程: 文件所在的项目名。
// 作者：**，修改者：**
// 描述:说明文件的功能。
// 主要函数：…………
// 版本: 说明文件的版本，完成日期。
// 修改: 说明对文件的修改内容、修改原因以及修改日期。
// 参考文献： ......
/////////////////////////////////////////////////////////////////////
2、变量名的注释
变量的注释应该紧跟变量名定义。
bool IsStarted;//用于标志程序某个功能部件是否已经开始工作。
3、函数的注释
//================================================================//
// 功能： 从一个String 中删除另一个String。
// 参数： strByDelete,strToDelete
// （入口） strByDelete: 被删除的字符串（原来的字符串）
// （出口） strToDelete: 要从上个字符串中删除的字符串。
// 返回： 找到并删除返回1，否则返回0。（对返回值有错误编码的要// 求列出错误编码）。
// 主要思路：本算法主要采用循环比较的方法来从strByDelete中找到
// 与strToDelete相匹配的字符串，对多匹配strByDelete
// 中有多个strToDelete子串）的情况没有处理。请参阅：
// 书名......
// 调用方法：......
// 日期：起始日期，如：2000/8/21.9:40--2000/8/23.21:45
//================================================================//
PS：在函数的上一行添加三个斜杠///，即可生成注释。生成的注释如下
/// <summary>
///
/// </summary>
public void Function(){}
二、命名部分
1、变量的命名
一般采用驼峰命名法和帕斯卡命名法。
驼峰命名法是指变量名第一个单词首字母小写，其余单词首字母大写的一种命名法。
public String sampleString;
而帕斯卡命名法是所有单词的首字母均大写的一种命名方法。
public String SampleString;
一般情况下，我们使用帕斯卡命名法，而对于方法参数、局部变量、委托参数等，我们采用驼峰命名法。
2、类的成员
成员变量前可以添加_，来区分一般的变量。
public class Student
{
public String _StudentName{get;set;}
}
3、方法的命名
一般采用动宾短语的形式。
public void StartExecute();
4、接口命名
接口名称前加I。
interface ISampleInterface
{
void SampleMethod();
}
三、其他技巧
1、缩进的调整：将要对齐的代码部分的最后一个 } 删除，然后添加 } ，即可达到自动对齐的效果。
2、手动缩进：使用Tab键而非Space即可方便的调整代码的缩进。
3、类的成员变量声明在顶端，并空一行将它们和方法隔开，这样可以使代码变得美观。
4、在函数内部每隔一定的距离添加注释，这样可以大大增加代码的可读性。
5、变量的命名要有实际的含义。一般对于变量命名有两个要求，一是能够看出变量的类型，二是能够看出变量的实际含义。
6、使用{}，即使是for、if等语句块只有一行代码。这个习惯能够帮助你在该语句块增加语句的时候不致出错。