注釋對于增加程序的易讀性和可維護性非常重要，同時在編程的過程中，也有助于程序員使其思路更加清晰，降低出現邏輯錯誤的幾率。對于注釋的風格，往往采取下面的策略。

成都創新互聯公司專業為企業提供衢江網站建設、衢江做網站、衢江網站設計、衢江網站制作等企業網站建設、網頁設計與制作、衢江企業網站模板建站服務，10多年衢江做網站經驗，不只是建網站，更提供有價值的思路和整體網絡服務。

1．文件級注釋

文件級注釋在于說明整個代碼文件的功能，常常還包含作者信息、創建日期信息等，便于代碼的后期維護。一個典型的文件級注釋如下所示。

上面示例給出了一個較為典型的文件級注釋，讀者可以根據自身的情況，指定統一的注釋規范。

2．函數級注釋

函數級注釋用于說明某個函數具體完成的功能、輸入參數類型、輸出結果等信息，便于函數的調用。一個典型的函數級注釋如下所示。

VS.NET開發環境可以自動生成這個風格的函數注釋，只需要在方法前輸入"//"，VS.NET就自動生成注釋框架，開發者只需要在相應的地方填入相應的值就可以了。

這種風格的注釋還有其他優點，即當開發者使用這個方法時，VS.NET會給出提示信息。根據上面的例子，在使用SetInfomation方法時VS.NET給出的提示信息。

3．代碼功能塊級注釋

在邏輯嚴密的方法實現中，常常是一個代碼塊完成一個特定的子問題，稱這樣一個代碼塊為功能塊。對于函數的功能塊添加注釋可以理順整個函數的功能，尤其體現在行數較多的函數中。如下面的示例所示。

 

 

如上面的示例，代碼功能塊級的注釋往往可以注釋到這個功能塊的上面一行，而各個功能塊之前使用空行來分隔。有了這樣的功能塊注釋，整個函數的實現邏輯顯得更為清晰，便于從整體上把握函數的實現，避免在實現一些邏輯復雜的功能時出現混亂。

4．代碼行級注釋

除了上面3種注釋，還需要在代碼行上加必要的注釋以進一步增強代碼的可讀性，當然，并不需要在每一行上都加注釋，只需要在比較復雜的某些行上加以注釋即可。代碼行級的注釋往往加在本行的后面，如下所示。

 

分享名稱：C#中如何規范化注釋
轉載來于：http://vcdvsql.cn/article16/gjicdg.html

成都網站建設公司_創新互聯，為您提供全網營銷推廣、網站維護、關鍵詞優化、小程序開發、外貿建站、網頁設計公司

廣告

聲明：本網站發布的內容（圖片、視頻和文字）以用戶投稿、用戶轉載內容為主，如果涉及侵權請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網站立場，如需處理請聯系客服。電話：028-86922220；郵箱：631063699@qq.com。內容未經允許不得轉載，或轉載時需注明來源： 創新互聯