问在.NET中使用XML注释有哪些优点？

EN

这里没有一个正确的答案，海事组织。在现实中，这两个系统都不是“更好”的--它们最终都做了相同的工作，这允许您生成代码文档。

最后的输出可以用完全相同的方式对每个输出进行格式化，而且它们在支持什么标签等方面确实具有几乎相同的功能，所以这取决于个人的选择。

就我个人而言，我发现XML注释更具有可读性，更符合逻辑，而且简单易用--但它的另一个优点是让visual studio自动生成存根供我填写，以及它对折叠它们的出色支持，这样它们就不会占用大量的屏幕空间。我相信来自VI或some_other_IDE背景编辑的人会有不同的看法，但这两者都没有真正的优势。

因此，我想说，这实际上取决于您正在使用的IDE，以及您和您的团队习惯使用的IDE。

现在，如果您询问Microsoft为什么选择将其与Visual中的XML注释紧密集成在一起，这是一个不同的问题。很可能是因为这样的事实:他们在VS中实现会更简单(因为他们可以重用现有代码来生成/读取注释和构建intellisense等等)，他们有一种坚持“标准”的趋势(不管是自己的还是行业的)，还有Jeff提到的许可理由。

只是想补充一下，微软在VS中使用的产品被称为“沙堡”，这是一个内部的XML文档生成工具。它有自己的wiki页面@ http://docproject.codeplex.com/Wikipage

1. ide获取注释并在使用该方法时显示它们。
2. 编写C#程序的每个人都可能熟悉XML系统。有更少的学习为新的雇用。

我并不是说DOxygen没有更好，只是每个人都更熟悉xml注释系统，这很有帮助。这只是你需要培训一名新员工来做的一件事。

至于没有注释的变量。对你来说可能是显而易见的，对其他人(或6个月后的你)来说不会是明显的。

好了，我想我明白你的要求了。

1. 模糊的评论。颜色编码有帮助。就我个人而言，我快速扫描了灰色文本，并且只读取绿色的内容，除非我需要读取xml文本。(至少在我的设置中)。
2. 我们有较大的显示器，所以我们得到更多的代码在屏幕上的一般情况。(买一台大型显示器比再培训一般人要便宜)。另外一点是，我敢打赌，您一次只在积极地查看一个函数，所以如果整个函数都适合在一个页面上，那么您可能不会因为没有看到更多的代码而感到太痛苦。现在，如果函数是长的，那么我可以看到这是一个问题。
3. 如果可能的话，我们将摘要注释放在一行上(假设它不是很大)。减少了旧的空间。
4. 我不知道DOxygen是否会这么做，但是您可以将注释折叠起来，这样它们就不碍事了。

XML文档的主要工作不是生成文档。它是为您类的客户端提供良好的IntelliSense信息。将生成的.xml文件随程序集一起传送。