C开发规范.docx

1.  命名规范
a) 类
【规则1-1】使用Pascal规则命名类名,即首字母要大写。
eg:
Class Test
{
}
【规则1-2】使用能够反映类功能的名词或名词短语命名类。尽量不使用缩写,而用全写。例如:使用CollegeStudent而不用CollegeStu。
【规则1-3】不要使用“I”、“C”、“_”等特定含义前缀。
【规则1-4】自定义异常类应以Exception结尾。
eg:
Class TestException
{
}
【规则1-5】文件名要能反映类的内容,最好是和类同名。
 
b) 类字段(类成员)
【规则2-1】用camel规则来命名类成员变量名称,即首单词(或单词缩写)小写。
【规则2-2】类字段变量名前可加“_”前缀。
【规则2-3】坚决禁止在普通变量前加“m_”(这是VC老命名规则)。
eg:
Class Test
{
    privatestring myName;
    privatestring _myCoCo;
    ...
}
c)方法
【规则3-1】方法名采用Pascal规则,第一个字符要大写。
【规则3-2】方法名应使用动词或动词短语。
【规则3-3】类中访问修饰符或功能相同的方法应该放在一起, 且公共或实现接口的方法在前。
eg:
Class Test
{
      ...
      publicvoid GetData(...)
      {
         ...
      }
 
      privatevoid GetName(...)
      {
         ...
      }
     
      privatestatic void GetCount(...)
      {
         ...
      }
 
 
}
d)属性
【规则4-1】使用名词定义属性,属性使用Pascal规则,首字符大写
【规则4-2】属性和相应字段名称要关联, 可以使用“重构”菜单来生成属性。
eg:
Class Test
{
   private string myName;
   public string MyName
   {
      set
      {
         myName = Value;
      }
      get
      {
         return myName;
      }
   }
}
e)参数
【规则5-1】参数采用camel规则命名,且首字符小写。
【规则5-2】使用描述性参数名称,参数名称应当具有最够的说明性。
【规则5-3】不要给参数加匈牙利语类型表示法的前缀。
【规则5-4】检查方法所有输入参数的有效性。
      eg:
      ClassTest
      {
         public void GetData(string name,string strFlag)
         {
            ...
         }
      }
   f)常量
    【规则6-1】只读常量使