【C#编程最佳实践 七】代码书写规范实践

以下规范都是个人书写习惯，便于阅读总结的个人规范，对于每个人可以有自己的理解。终极目标就是消除警告呀哈哈。

布局规范

对于项目的总体规范，建议分为以下几部分：1，对外提供服务的文件。2，配置文件和配置文件解析类（如果有）。3，接口文件夹（接口和实现类）。4单元测试文件夹。5，实体类文件夹。

命名规范

1，接口的命名：例如IConditionKeyBuilder，以I开头，方式+名词
2，类的命名：驼峰命名法
3，方法的命名：动词：GetConditionKey（）
4，字段的命名：_keyCondition
5，属性的命名：GetConditionKey（在C#里能用属性不用字段，基本都用属性）

注释规范

类的注释

类+属性（服务提供类）或来源（某接口的实现类）+具体功能

接口的注释

接口+属性（字段比较规则接口）或来源（某接口的子接口）+具体功能

方法的注释

方法属性（私有还是公有）+功能+参数列表

属性的注释

属性要完成的功能

流程注释

1，数据预处理注释：这一部分用来预处理想要处理的数据
2，核心功能方法注释：核心功能为一个区域，用注释隔离开
3，辅助方法注释：辅助需要的方法为一个区域，也用注释隔离

每一个功能的辅助方法集合都要用一个region来包含，核心方法也是，用region隔开

常用规范

以下内容引自武哥，尊重知识产权https://www.evernote.com/shard/s69/sh/aabd8e65-b619-4a77-baf7-fde4886299b5/6ce578ef4547559d

1.能使用foreach 不使用 for

原因：
foreach (var i in getlist() )            //getlist() 只会执行一次
for(int i=0;i< getlist().count ;i++)     //getlist() 会执行多次

2.如果throw 的异常是一种己知的异常，应该自定义一个异常类

throw new Exception(“数据己存在”)
//改成  throw new DataExistedException()

3.有效复用

大代码中出现大量常见重复的判断值有效性或提取对象里的信息的场景，应该封装成一个函数方便复用。
示例：

if(obj.name==null || obj.list==null || obj.list.count==0)     
//添加函数 isValidValue(obj)
return $("{obj.app}.{obj.metaobject}.{obj.feildname}”)
//添加函数 obj.GetXX()   或  GetXX(obj)
return result=resultData.Count > 0 :true?false ;
//改成   isSuccess(resultData)

4.代码中常用或多个地方会使用到的字符串不能使用明文， 应该用常量。

示例
sortFields.Add("_uid", SortDirection.Asc);
//改成
public const string UID_Field = “_uid”
sortFields.Add(UID_Field, SortDirection.Asc);

5.参数有效性验证

代码给外层提供服务的接口，函数第一行， 就应该要给传入的参数进行有效性验证 (如：Provider中的public函数）

public DataResult<bool> ImportObjectData(string ids, bool isTransferAll = false)
{
   string[] idArray = ids.Split(',');
   if (ids.Count() > 0)
   {
       //run ….
   }
}

改成
public DataResult<bool> ImportObjectData(string ids, bool isTransferAll = false)
{
   ArgumentHelper.AssertPositive(ids, "ids");
   string[] idArray = ids.Split(',');
   if (ids.Count() > 0)
   {
       //run ….
   }
}

6.关于注释

• 1.Model里的属性一定要有注释，同时要确保注释是正确的。

• 2.Class一定要有描述是干什么事情的

• 3.核心代码，关键算法一定要注释清楚为什么是这样做的，场景是什么？而不是只注释函数在干什么？

• 4.函数的参数注释要与代码匹配

7.关于代码的可读性

1.每个函数一般要求“圈复杂度”不超过5

8.关于函数命名

1.函数命名要统一规范， 如： getXXX() getXXXs() isXXX() hasXXX()
2.函数命名要能表达函数的操作行为，命名应该是动词。 如： run() getXXX()

9.关于变量的使用

1.当变量只有一个地方使用时，就不使用变量。

示例：
Exception ex = new Exception("RelationFilter Range条件配置错误：" + User.Common.Serialize.SerializeHelper.Serialize(relationFilter));
throw ex;
改成
throw new Exception("RelationFilter Range条件配置错误：" + User.Common.Serialize.SerializeHelper.Serialize(relationFilter));

2.进行大量反复修改变量值时（如 i++ )，应该使用局部变量，不要直接使用全局变量进行i++操作. 这样性能更高。

示例
public static int i =0;
public void fun(){
    for(int n=0;n<1000;n++)
   {
        i++;
   }
}
改成
public void fun(){
   int i=0;
   for(int n=0;n<1000;n++)
   {
        i++;
   }
}

10.关判断参数是否为空

ArgumentHelper.AssertNotEmpty(name,”name”)
判断值是否大于0
ArgumentHelper.AssertPositive(userId,”userId”)
判断是否为null
ArgumentHelper.AssertNotNull(objectData,”objectData”)11.关于性能

1.使用String.Empty 代替 “"

string name="";
改成
string name=String.Empty;