* **類型**、**屬性**、**事件**、**方法**、**方法參數**，根據需要添加注釋。
* 如果類型、屬性、事件、方法、方法參數的名稱已經是自解釋（從命名就可以看出明確的意思）了，則不需要加注釋；否則必須添加注釋。
* 整個項目的有效注釋率必須在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;
}
}
}
~~~
