如何在方法中使用xml註釋

Question

我在VS 2005中使用xml註釋很多，但現在我遇到了問題。我需要評論IFs，WHILEs，SELECT CASE等。但VS總是告訴我，這是不可能的。有沒有一些解決方法？

這真的會幫助我。

Answer 1

XML註釋很有用，因爲工具能夠讀取和理解它們。因此，例如，如果在代碼中使用具有XML註釋的方法並將鼠標懸停在其上，則IDE可能會告訴您<summary>。或者您可以使用它們來生成文檔網站。

但是這些都不適用於內嵌評論。只有當你真正在查看有問題的代碼時，它們纔對你有用，所以沒有理由爲什麼工具應該能夠理解它們。我不知道有哪些工具可以做到這一點。

但是，如果您有內聯使用XML註釋的一些充分理由（例如，如果您使用的是一些自定義文檔工具），則沒有什麼能夠阻止您，它仍然是有效的C＃。但編譯器無法識別這些XML註釋，因此它們不會出現在生成的XML文件中。