關於XML注釋的一點隨筆

本文僅供初學者閱讀，老手飄過（可以指點~~）

下面說一下我在用XML注釋時的一些發現，或是經過。希望對你有用。

剛開始看到別人寫的代碼中都有這樣的注釋：

剛開始很不知道這是幹嘛的，也不知道是如何出來的。知道是XML，但是不知道用來做什麼的，在網上查了一下要如何才能有這種效果，不過沒有找到。當時還想在學習一下XML之後再來寫代碼的。不過後來……

後來偶然間在寫完一個類之後在類上添加該類的注釋的時候按下了三個注釋的符號（我用的vb.net）出現這樣的狀況：

於是乎，瞭解了原來這樣就可以了。於是竊喜，並且在每個類以及類的方法上面都加了這樣的標記並添了注釋：

不過後來在調用這個借口時發現了一個問題：

原來這個XML注釋的作用在此。

      總結說，也就是在一個類的方法上面加上這樣的XML注釋之後在調用這個類的方法時就可以得到相應的提示，並且是自己添加的提示。這樣的話如果用在大的項目中，即便是拿到一個類庫不是自己編的，只要有這樣的說明一樣可以很好的使用。相反你自己在編類庫的時候也要想到有一天別人會拿來用，要如何才能讓別人一看就知道你這個類的方法怎麼使用，這就是一個很好的辦法。