您在代码文件中使用了多少XML注释，以及如何使用它们？我已经看到你可以用它们来生成XML文档，但是这个XML文档可以用来为你的代码生成一个HTML帮助文件或模式文件吗？
另外，您是否使用过任何自动生成评论工具（即GhostDoc），您的印象是什么？
思想？
答案 0 :(得分：4)
如果您从构建中分发XML文件以及DLL，那么XML文档本身就很有用。这样，API的任何消费者都可以从IDE中获得有用的信息（通过Intellisense或对象浏览器）。
现在，XML注释的最大用途可能是从这些构建的XML文件生成帮助文档。 Microsoft Sandcastle目前是解决这个问题的方法。它可以生成HTML帮助1（即CHM）文件或HTML帮助2（即可以集成到Visual Studio帮助中的帮助文件）。 （注意：在过去，NDoc的选项似乎更具吸引力 - 有些人仍然使用它 - 但Sandcastle目前似乎是官方和推荐的方法，特别是考虑到它相当稳定和完全足够几乎任何目的。）参见SandcastleDocs网站开始（这是微软的一位开发人员非正式地把它放在一起我相信）。特别是，您需要查看Sandcastle Help File Builder GUI - 根据我的经验，我发现它是一个很好的工具。
答案 1 :(得分：3)
我尝试为任何方法做到这一点，但它的作用并不明显。我喜欢它包含Intellisense中的文档。
答案 2 :(得分：2)
是的，我确实使用了此功能，并认为所有开发人员都可以对其api进行评论。一旦你完成了一些api，只要你掌握它，它就不会太难维护。
选项1：SandCastle 我尝试使用它，但我发现有太多的安装程序，我必须运行和安装，并学习配置。最后，我最终得到了一个chm文件，但实际上我想要一些轻量级的东西。
好处是最终产品看起来非常专业。但这对我的情况不起作用。
选项2：NDoc 上次我检查时，这个项目没有被维护，只适用于.NET 1.1版。
选项3：XSLT CodeProject上有人为此编写了一个xslt文件
http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx
我试过了，这就是它的工作原理。 构建项目并将xslt文件放入与输出的xml文件相同的目录中。双击xml文件时，将显示格式化的网页，而不是xml文档。
对我来说，这是最好的选择。
答案 3 :(得分：1)
是的！我使用它们，并且所有项目都要求我执行包含它们的操作。至于所包含的详细程度，它取决于代码的目的。至少所有参数和公共方法都有摘要信息。复杂项目通常包含代码示例，并记录所有特定抛出的异常。
现在我正在使用SandCastle进行文档构建，您可以毫无问题地转到HTML或CHM！我也使用过SlickEdit进行即时解析，它的效果也很好！
答案 4 :(得分：1)
至少我包含对公共API的注释并生成xml文件。这足以使intellisense工作，它也出现在Reflector中。
就个人而言，我不打算使用沙堡等 - 但我可能会参加ISV项目。
答案 5 :(得分：1)
我过去曾使用过Microsoft的SandCastle工具从Xml评论中生成MSDN样式文档，并且运气真的很好。据说它是用于生成所有.net框架文档的工具，这些文档也恰好来自Xml注释。
答案 6 :(得分：0)
我们使用XML注释记录所有方法和属性。两者都用于内部文档目的，并且能够为二进制文件提供帮助文件。在intellisense中弹出方法的文档特别好。
我们正在使用GhostDoc - 它可以提供 - 通常可以 - 默认文档，但请记住，GhostDoc只能记录它可以从方法和参数名称推断出来的内容。因此，我们的规则是您可以使用GhostDoc来启动文档;然后适当地编辑它 - 在许多情况下，参数的默认文档就可以了。在简单的情况下，如果有意义的话，我们也会坚持使用默认文档。
可以使用Sandcastle (download)生成帮助文件。此外，the Sandcastle Help File Builder是一个GUI，可以让您更轻松地开始使用Sandcastle。
答案 7 :(得分：0)
我正在利用NuDoc生成降价格式的静态API网站。 API干净，现代，非常轻巧，易于使用（如果我自己可以这样说的话）;）：http://kzu.to/nudoc
它也是开源的，因此总是欢迎修复和改进。