c#標準注釋

模組（類）注釋規範

模組開始必須以以下格式編寫模組注釋

///<summary>

///模組編號：<模組編號，可以引用系統設計中的模組編號>

///作用：<對此類的描述，可以引用系統設計中的描述>

///作者：作者中文名

///編寫日期<模組建立日期，格式：YYYY-MM-DD>

///</summary>

 

如果模組有修改，則每次修改必須添加以下注釋

///<summary>

///Log編號：<Log編號，從1開始一次增加>

///修改描述：<對此修改的描述>

///作者：修改者的中文名

//修改日期：<模組修改日期：格式：YYYY-MM-DD>

///</summary>

 

 

類屬性注視規範

///<summary>

///屬性說明

///</summary>

 

 

方法注釋規範

///<summary>

///說明：<對該方法的說明>

///</summary>

///<param name="<參數名稱>"><參數說明></param>

///<returns>

///<對此方法傳回值的說明，該說明必須明確說明傳回值代表什麼含義。>

///</returns>

 

 

代碼間注視規範

//<單行注釋>

/*多行注釋1

  多行注釋2

  多行注釋3*/

 

#c#雜項