c# 類注釋


我頂 字號:

引用:http://fanlynn.blog.hexun.com/22181090_d.html

模塊(類)注釋規范

文件頭部注釋

在代碼文件的頭部進行注釋,這樣做的好處在於,我們能對代碼文件做變更跟蹤。在代碼頭部分標注出創始人、創始時間、修改人、修改時間、代碼的功能,這在團隊開發中必不可少,它們可以使后來維護/修改的同伴在遇到問題時,在第一時間知道他應該向誰去尋求幫助,並且知道這個文件經歷了多少次迭代、經歷了多少個程序員的開發和修改。

樣本:

/********************************************************************************

** 作者: Eunge

** 創始時間:2004-6-8

** 修改人:Lucy

** 修改時間:2004-12-9

** 修改人:Lucy

** 修改時間:2005-01-29

** 描述:

**    主要用於產品信息的資料錄入,…

*********************************************************************************/

模塊開始必須以以下形式書寫模塊注釋:

///

         ///模塊編號:<模塊編號,可以引用系統設計中的模塊編號>

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

         ///作者:作者中文名

         ///編寫日期:<模塊創建日期,格式:YYYY-MM-DD>

         ///

如果模塊有修改,則每次修改必須添加以下注釋:

         ///

         ///Log編號:<log< SPAN="">編號,從1開始一次增加>

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

         ///作者:修改者中文名

         ///修改日期:<模塊修改日期,格式:YYYY-MM-DD>

         ///

 

3.2.2. 類屬性注釋規范

在類的屬性必須以以下格式編寫屬性注釋:

         ///

         ///屬性說明

///

3.2.3. 方法注釋規范

在類的方法聲明前必須以以下格式編寫注釋

         ///

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

         ///

          ///<參數說明>

         ///

         ///<對方法返回值的說明,該說明必須明確說明返回的值代表什么含義>

         ///

 

3.2.4. 代碼間注釋規范

代碼間注釋分為單行注釋和多行注釋:

         單行注釋:

//<單行注釋>

         多行注釋:

         /*多行注釋1

          多行注釋2

          多行注釋3*/

代碼中遇到語句塊時必須添加注釋(if,for,foreach,……),添加的注釋必須能夠說明此語句塊的作用和實現手段(所用算法等等)。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM