溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
注釋對于增加程序的易讀性和可維護性非常重要，同時在編程的過程中，也有助于程序員使其思路更加清晰，降低出現邏輯錯誤的幾率。對于注釋的風格，往往采取下面的策略。
1．文件級注釋
文件級注釋在于說明整個代碼文件的功能，常常還包含作者信息、創建日期信息等，便于代碼的后期維護。一個典型的文件級注釋如下所示。
 |
上面示例給出了一個較為典型的文件級注釋，讀者可以根據自身的情況，指定統一的注釋規范。
2．函數級注釋
函數級注釋用于說明某個函數具體完成的功能、輸入參數類型、輸出結果等信息，便于函數的調用。一個典型的函數級注釋如下所示。
 |
VS.NET開發環境可以自動生成這個風格的函數注釋，只需要在方法前輸入"//"，VS.NET就自動生成注釋框架，開發者只需要在相應的地方填入相應的值就可以了。
這種風格的注釋還有其他優點，即當開發者使用這個方法時，VS.NET會給出提示信息。根據上面的例子，在使用SetInfomation方法時VS.NET給出的提示信息。
3．代碼功能塊級注釋
在邏輯嚴密的方法實現中，常常是一個代碼塊完成一個特定的子問題，稱這樣一個代碼塊為功能塊。對于函數的功能塊添加注釋可以理順整個函數的功能，尤其體現在行數較多的函數中。如下面的示例所示。
 |
 |
如上面的示例，代碼功能塊級的注釋往往可以注釋到這個功能塊的上面一行，而各個功能塊之前使用空行來分隔。有了這樣的功能塊注釋，整個函數的實現邏輯顯得更為清晰，便于從整體上把握函數的實現，避免在實現一些邏輯復雜的功能時出現混亂。
4．代碼行級注釋
除了上面3種注釋，還需要在代碼行上加必要的注釋以進一步增強代碼的可讀性，當然，并不需要在每一行上都加注釋，只需要在比較復雜的某些行上加以注釋即可。代碼行級的注釋往往加在本行的后面，如下所示。
 |
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
