.net NET中的XML代码注释

您在代码文件中使用了多少XML注释，以及如何使用它们？我已经看到可以使用它们生成XML文档，但是这个XML文档可以用于为代码生成HTML帮助文件或模式文件吗

此外，您是否使用过任何自动生成评论的工具（如GhostDoc），您的印象如何

---

想法？

是的！我使用它们，所有项目都要求我做我们包含它们的事情。至于包含的详细程度，则取决于代码的目的。至少所有参数和公共方法都有摘要信息。复杂项通常有代码示例，所有特定抛出的异常都有文档记录

---

现在我正在使用SandCastle进行文档构建，您可以毫无疑问地转到HTML或CHM！我还使用了SlickEdit，它可以进行动态解析，效果也很好

是的，我确实使用了此功能，并且认为所有开发人员都可以对其api进行注释。一旦您为几个API完成了这项工作，并且只要您掌握了它，维护起来就不难了

备选方案1：沙堡 我尝试过使用它，但是我发现有太多的安装程序需要我运行、安装并学习配置。最后，我得到了一个chm文件，但我真的想要一些轻一点的东西

好处是最终产品看起来非常专业。但这对我的处境不起作用

备选案文2:NDoc 上次我检查时，这个项目没有得到维护，只使用了.NET的1.1版

选项3：XSLT CodeProject上有人为此编写了xslt文件

我试过了，下面是它的工作原理。 构建项目并将xslt文件放入与输出的xml文件相同的目录中。双击xml文件时，将显示格式化的网页，而不是xml文档

---

对我来说，这是最好的选择。

至少我会为公共API添加注释并生成xml文件。这足以让智能感知工作，它也在反射器中显示出来

---

就我个人而言，我不想为sandcastle等问题操心，但我可能会为ISV项目操心。

我们用XML注释记录所有方法和属性。既可以用于内部文档，也可以为二进制文件提供帮助文件。在intellisense中弹出一个方法的文档尤其好

我们使用的是GhostDoc，它可以提供一个默认的文档，但请记住，GhostDoc只能记录它从方法和参数名中推断出的内容。因此，我们的规则是，您可以使用GhostDoc来启动文档；然后适当地编辑它——在许多情况下，参数的默认文档就可以了。在简单的情况下，如果有意义的话，我们也会坚持使用默认文档

---

可以使用生成帮助文件。另外，它是一个GUI，可以让您更轻松地开始使用Sandcastle。

我尝试使用任何不明显的方法。我喜欢它包含Intellisense中的文档。

我过去曾使用Microsoft的SandCastle工具从Xml注释生成MSDN样式的文档，真的很幸运。据推测，它是用来生成所有.net framework文档的工具，这些文档碰巧也来自Xml注释

---

如果您将生成中的XML文件与DLL一起分发，XML文档本身可能很有用。这样，API的任何使用者都可以从IDE中获得有用的信息（通过Intellisense或对象浏览器）

---

现在，XML注释的最大用途可能是从这些构建的XML文件生成帮助文档。是目前解决这个问题的方法。它可以生成HTML帮助1（即CHM）文件或HTML帮助2（即可以集成到Visual Studio帮助中的帮助文件）。（注意：在过去，NDoc的选择似乎更具吸引力——一些人仍在使用它——但目前Sandcastle似乎是官方推荐的方法，特别是考虑到它的稳定性和完整性，几乎可以用于任何目的。）请访问网站开始（我相信这是由微软的一位开发人员非正式组合而成的）。特别是，你会想看看GUI——根据我的经验，我发现它是一个很好的工具。

我正在利用NuDoc以降价格式生成静态API站点。API干净、现代、非常轻量级且易于使用（如果我自己可以这么说的话；）：

它也是开源的，所以修复和改进总是受欢迎的