如何在 vb.net 中导出 XML 代码文档？答案

【问题标题】：How can I export XML code documentation in vb.net?如何在 vb.net 中导出 XML 代码文档？
【发布时间】：2020-09-05 07:11:28
【问题描述】：

在 vb.net 中，我可以使用一些标签来编写 XML 文档，如下所示

'''<summary>
''' Hello there!
'''</summary>

在 Java 中，我只需单击一下即可导出我的 Javadoc 文档（它会生成一个 Html 文件）。

有没有办法在 vb.net 中做类似的事情？

【问题讨论】：

当您将鼠标悬停在方法上或在智能感知完成期间，如果文档在 IDE 中可见，您为什么需要它？
以防万一：softwarerecs.stackexchange.com/a/265
@Fabio 与 Oracle 提供以 html 格式导出 Java 文档的原因相同：在不打开 IDE 的情况下阅读方法行为并创建一个单独的文档文件，在不同的情况下很有用！ :) 谢谢你的建议！我要读你的链接！
@Fabio：生成的文档可能比您在 VS Intellisense 中看到的要复杂得多。它可以包含图片、表格、示例和相关文档的链接。这正是 .NET 框架的 MSDN 文档的工作原理。另一种情况 - 最终用户。如果您创建一个可重用的组件、控件或可扩展系统，并具有最终用户可以使用的明确定义的 API，那会怎样。您需要为他们提供体面的文档。
@Fabio 没错，但并非总是如此。例如，VSdocman 可以读取 XML cmets 中的标签并自动生成图片或类图。我认为 Sandcastle 能够做类似的事情。其他提到的格式是标准 XML cmets 的一部分，因此它们也是自动生成的。表、示例、、链接 <see> 和 <seealso>。见<a href="/default/index/tourl?u=aHR0cHM6Ly9kb2NzLm1pY3Jvc29mdC5jb20vZW4tdXMvZG90bmV0L2NzaGFycC9wcm9ncmFtbWluZy1ndWlkZS94bWxkb2MvcmVjb21tZW5kZWQtdGFncy1mb3ItZG9jdW1lbnRhdGlvbi1jb21tZW50cw%3D%3D" rel="nofollow" target="_blank">docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/…</a></seealso></see>

【解决方案1】：

有几种工具可以从 XML cmets 生成 HTML 或其他格式的文档。其中一些：

VSdocman - 从 C# 和 VB 项目生成 API 文档的工具。它可以生成多种格式，包括 HTML、CHM、PDF、Docx 等。它还在 Visual Studio 中提供了 WYSIWYG XML cmets 编辑器。这是一个商业产品，我是作者。
Sandcastle Help File Builder - 一组工具，用于为包含概念和 API 参考主题的托管类库创建帮助文件。免费。
DocFX - 可扩展和可伸缩的静态文档生成器。免费。

【讨论】：