當我們的程式碼行數變多,一段時間後,我們會忘記之前編輯程式碼的意思,需要重新讀我們之前編寫的程式碼,這樣加重了開發的負擔。這時候我們就需要一個我們編寫程式碼的說明,從而透過說明很快的想起之前編寫程式碼的思路,同時看別人的程式碼說明,也能很快上手學習和修改別人的程式碼。
這時候,我們就需要程式碼註釋(標註和解釋,簡稱註釋)
註釋就是對程式碼的解釋和說明。目的是為了讓別人和自己很容易看懂,一看就知道這段程式碼是做什麼用的,提高程式程式碼的可讀性。
註釋只是為了提高可讀性,不會被計算機編譯。
一、C#的註釋有三種,單行註釋、多行註釋、文件註釋
單行註釋:適用註釋一行內容(簡短的一行解釋)
語法://註釋內容
多行註釋:適用註釋跨行內容(比較多的跨行解釋)
語法:/*註釋內容*/
/*多行註釋開始識別符號
*/多行數值結束識別符號
文件註釋:給程式碼段添加註釋(解釋一段整體內容)
語法:///
///
///
注:只需要在對應位置敲入///Visual Studio會將其餘內容自動生成
文件註釋可以用在名稱空間、類、函式上,但是我們發現當使用在名稱空間、類上的時候僅僅是
但是使用在入口函式上的時候卻變成
這是怎麼回事?
其實對於文件註釋,我們經常用到的是三種標識summary、param、returns
summary:摘要資訊
param:引數說明
returns:返回值說明
簡單舉例
ctrl+k+c:註釋所選程式碼
ctrl+k+u:取消對所選程式碼的註釋
三、註釋常見錯誤
巢狀多行註釋錯誤
多行註釋使用過程中,一個/*只能直接對應一個*/,否則巢狀過程中/*會直接匹配所在範圍的第一個*/而將其餘的註釋忽略
單行註釋嵌多行註釋錯誤
單行註釋會將這一行的所有內容都認成註釋,此時的/*會被識別成單行註釋的一部分,而並沒有識別成多行註釋的開始識別符號
四、註釋兩大作用
程式碼解釋和程式碼除錯
程式碼解釋就是在對應程式碼位置,起到程式碼意思標識的作用
程式碼除錯: