如何在方法中使用xml注释

Question

我在VS 2005中使用xml注释很多，但现在我遇到了问题。我需要评论IFs，WHILEs，SELECT CASE等。但VS总是告诉我，这是不可能的。有没有一些解决方法？

这真的会帮助我。

Answer 1

XML注释很有用，因为工具能够读取和理解它们。因此，例如，如果在代码中使用具有XML注释的方法并将鼠标悬停在其上，则IDE可能会告诉您<summary>。或者您可以使用它们来生成文档网站。

但是这些都不适用于内嵌评论。只有当你真正在查看有问题的代码时，它们才对你有用，所以没有理由为什么工具应该能够理解它们。我不知道有哪些工具可以做到这一点。

但是，如果您有内联使用XML注释的一些充分理由（例如，如果您使用的是一些自定义文档工具），则没有什么能够阻止您，它仍然是有效的C＃。但编译器无法识别这些XML注释，因此它们不会出现在生成的XML文件中。