c#標準註釋

鴨脖發表於2012-11-08

模組(類)註釋規範

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

///<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*/

 

相關文章