C#中如何規(guī)范化注釋

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

1．文件級注釋

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

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

2．函數(shù)級注釋

函數(shù)級注釋用于說明某個函數(shù)具體完成的功能、輸入?yún)?shù)類型、輸出結(jié)果等信息，便于函數(shù)的調(diào)用。一個典型的函數(shù)級注釋如下所示。

VS.NET開發(fā)環(huán)境可以自動生成這個風(fēng)格的函數(shù)注釋，只需要在方法前輸入"//"，VS.NET就自動生成注釋框架，開發(fā)者只需要在相應(yīng)的地方填入相應(yīng)的值就可以了。

這種風(fēng)格的注釋還有其他優(yōu)點(diǎn)，即當(dāng)開發(fā)者使用這個方法時，VS.NET會給出提示信息。根據(jù)上面的例子，在使用SetInfomation方法時VS.NET給出的提示信息。

3．代碼功能塊級注釋

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

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

4．代碼行級注釋

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