* **类型**、**属性**、**事件**、**方法**、**方法参数**，根据需要添加注释。
* 如果类型、属性、事件、方法、方法参数的名称已经是自解释（从命名就可以看出明确的意思）了，则不需要加注释；否则必须添加注释。
* 整个项目的有效注释率必须在20%以上。
* 注释的优先级为：工具类>业务逻辑类>实体类&查询条件类>Provider>SqlProvider。
* 注释语言必须准确、易懂、简洁。如果有能力，可使用中英双语进行注释
注释示例如下：
~~~
/// <summary>
/// 分页数据封装
/// </summary>
/// <typeparam name="TEntity">分页数据的实体类型</typeparam>
[Serializable]
public class PagingList<TEntity> : IPagingList<TEntity>
{
/// <summary>
/// 构造函数
/// </summary>
/// <param name="items">分页的数据</param>
/// <param name="totalCount">总记录数</param>
/// <param name="pageIndex">当前页码</param>
/// <param name="pageSize">每页显示记录数</param>
public PagingList(IReadOnlyList<TEntity> items, int totalCount, int pageIndex, int pageSize)
{
Items = items;
TotalCount = totalCount;
PageIndex = pageIndex;
PageSize = pageSize;
}
/// <summary>
/// 当前页码
/// </summary>
public int PageIndex { get; set; }
/// <summary>
/// 每页显示记录数
/// </summary>
public int PageSize { get; set; }
/// <summary>
/// 总记录数
/// </summary>
public int TotalCount { get; set; }
public IReadOnlyList<TEntity> Items { get; set; }
/// <summary>
/// 总页数
/// </summary>
public int TotalPages
{
get
{
var result = TotalCount/PageSize;
if (TotalCount%PageSize > 0)
result++;
return result;
}
}
}
~~~
