如何在方法中使用xml注释

Question

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

这对我有帮助。

Answer 1

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

但这些都不适用于内联评论。只有当您实际查看有问题的代码时，它们才对您有用，因此没有理由为什么工具应该能够理解它们。我不知道有任何工具可以做到这一点。

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