.NET中使用XML注释有什么好处？我无法理解使用XML注释的优势。我知道它们可以在代码之外变成很好的文档，但是使用更简洁的Doxygen语法可以实现相同的目标。在我看来，XML注释是错误的，因为：它们通常会混淆注释和代码。（它们更难被人类阅读）。可以在单个屏幕上查看更少的代码，因为“summary”和“/summary”需要额外的行。（已删除）那么，XML在.NET中比简单的Doxygen语法更受欢迎的原因可能是什么？这里没有真正正确的答案。事实上，这两个系统都不比另一个“更好”——它们最终都做同样的工作，这允许您生成代码文档。最终输出的格式可以完全相同，并且它们在支持的标签等方面确实具有相同的功能，所以这里真的取决于个人选择。就我个人而言，我发现XML注释更加人性化、合乎逻辑并且使用起来非常简单——但这有一个额外的好处，那就是让visualstudio自动生成存根供我填写，为折叠它们提供了极好的支持，因此它们不要在屏幕上占用太多空间。我敢肯定来自VI或some_other_IDE的后台编辑器的人会有不同的意见，但两者都没有真正的优势。所以我想说这真的取决于您使用的IDE以及您和您的团队的习惯。现在，如果您要问为什么Microsoft选择在VisualStudio中与XML注释紧密集成，那是另一个问题。很可能是因为在VS中实现它们会更简单（因为它们可以重用现有代码来生成/读取评论和构建智能感知等），它们倾向于坚持“标准”（无论是他们自己的还是行业的）)，以及Jeff提到的许可理由。补充一点，微软在VS中使用的产品称为“Sandcastle”，它是一个内部XML文档生成工具。它有自己的wiki页面@http://docproject.codeplex.com/Wikipageide使用该方法获取评论并显示它们。每个编写过C#程序的人都可能熟悉XML注释系统。新员工的学习曲线更少。我并不是说DOxygen不好，只是xml注释系统更被大家所熟悉，还有很长的路要走。您只需要培训新员工。至于不注释变量。对您来说显而易见的事情，对其他人（或从现在起6个月后的您而言）就不会了。好的，我想我知道你在问什么。混乱的评论。颜色编码有帮助。就我个人而言，我会快速扫描灰色文本，只阅读绿色文本，除非我需要阅读xml文本。（至少在我的设置中）。我们有大显示器，所以我们通常会在屏幕上显示更多代码。（买大显示器比买大显示器便宜）。与此相关的另一件事是，我敢打赌您一次只会主动查看一个函数，因此如果整个函数都适合页面，您可能不会因为看不到更多代码而受苦。现在，如果函数很长，那么我可以看出这是一个问题。我们尽可能将摘要注释放在一行中（假设它不是很大）。这减少了使用的空间。我不知道Doxygen是否这样做，但您可以删除注释，这样它们就可以了。XML文档的主要工作不是生成它。它是关于向您班级的客户提供良好的IntelliSense信息。将生成的.xml文件与程序集一起发送。在.NET中使用XML注释的优点C#编译器和VisualStudio原生支持它们，提供一个单一位置来记录您的API，以便在印刷、在线和IntelliSense文档中使用。这篇来自MSDN杂志的文章陈述如下：在每个项目中，都有一些人对文档不满意。团队领导希望在源代码中获得更多评论，技术作者希望获得更多关于代码设计的书面信息，QA想要查看功能规范，等等。如果所有这些文件实际上都已写入，您仍然需要使所有这些文件保持同步。虽然格式不一定是理想的，但XML文档注释提供了使这成为可能的丰富语法。为什么不在C#中支持DOxygen？至于为什么选择现有的XML系统而不是Doxygen，我怀疑主要是因为Doxygen是在GPL下发布的，这意味着VisualStudio和C#编译器也需要这样发布——微软当然不会这样做我想考虑GPL的条款。我发现更令人费解的是ghostdoc插件的流行。如果可以根据方法名自动生成注释，为什么还要注释呢？我很难不同意SteveYegge的观点，他说过多的评论是新手程序员的标志。您不必在项目中使用它们。它们是恰好集成到VisualStudio中的标准，如果您使用StyleCop，它们可以被强制执行。所以这是美德。然而，如果您决定使用Doxygen，没有什么能阻止您。只要确保你是一致的。以上就是C#学习教程：.NET中使用XML注释有什么好处？如果所有分享的内容对你有用，需要进一步了解C#学习教程，希望大家多多关注。本文收集自网络，不代表立场。如涉及侵权，请点击右侧联系管理员删除。如需转载请注明出处：
