【问题标题】:How to format Visual Studio XML documentation for display on the web如何格式化 Visual Studio XML 文档以在 Web 上显示
【发布时间】:2011-07-09 02:41:58
【问题描述】:

我正在使用 Visual Studio 2010,并开始成为一个好孩子,并在编写代码时通过 XML cmets 记录我的所有代码。我有一个文档齐全的项目,我什至想出了如何在构建时让 Visual Studio 吐出一个完整的 XML 文档。我的问题是,在网络上格式化/显示此文档的最佳方式是什么,以便它以像 MSDN 这样友好且可用的格式出现?有没有工具可以轻松做到这一点?

提前致谢!

【问题讨论】:

标签: c# xml visual-studio visual-studio-2010 comments


【解决方案1】:

查看Sandcastle

Sandcastle 通过反映源程序集和可选地集成 XML 文档注释来生成准确的 MSDN 风格的综合文档。

Wikipedia 提供更多信息以及与 sandcastle 集成的其他项目的链接。


另一个选项(似乎更容易使用)是docu

.Net 的文档生成器并不复杂、笨拙或难以使用。给定 Visual Studio 生成的程序集和 XML,docu 可以使用单个命令生成整个文档网站。


第三个选项是NDoc:

NDoc 从 .NET 程序集和由 C# 编译器(或使用 VB.NET 的附加工具)生成的 XML 文档文件生成类库文档。

NDoc 使用可插入式文档生成器以多种不同格式生成文档,包括 MSDN 样式的 HTML 帮助格式 (.chm)、Visual Studio .NET 帮助格式 (HTML 帮助 2) 和 MSDN 在线样式的网页。

【讨论】:

  • 这很有趣,这是我遇到的第一个。这似乎相当麻烦。我认为它不是从生成的 XML 文档中读取的,而是从 .cs 文件本身中读取的。这肯定是一种选择,但我想看看其他人是否有其他选择。
  • @Chevex - 多年来一直是王者...我已经用另一个选项更新了我的答案。
  • 我想使用沙堡,但它让我很困惑。我安装了它,但不清楚它去了哪里。它有图形用户界面吗?
  • @Chevex - 众所周知,它很难使用。查看我添加的其他选项。文档看起来不错。
  • 我希望我能找到一个很好的鲁棒教程来使用沙堡。它已安装,但我仍然不知道在哪里可以访问它的选项。
【解决方案2】:

查看Sandcastle Help File Builder。这是一个 GUI 工具,使 Sandcastle 非常易于使用。它将安装到“开始”菜单->“程序文件”->“Sandcastle 帮助文件生成器”中的文件夹中。它非常易于使用,但速度并不快。

希望有帮助!

【讨论】:

【解决方案3】:

NDoc 也是一个选项。但我会和沙堡一起去,这就是我所做的。

【讨论】:

    【解决方案4】:

    我创建了一个开源项目以在网页中公开它们 检查@AutoHelp

    AutoHelp 读取 DLL 和 XML Doc 文件,生成帮助页面并将它们公开给用户。 AutoHelp 使用 ASP.NET MVC 5、ASP.NET WebApi、TypeScript、jQuery 和 Bootstrap 成为现代 Web 应用程序。

    【讨论】:

    • 看起来很有希望,但过去 4 年没有任何活动。
    【解决方案5】:

    在 2020 年,您可能想选择doxygen。就像我的 .NET Core 项目的魅力一样。

    Doxygen 是从带注释的 C++ 源代码生成文档的事实上的标准工具,但它也支持其他流行的编程语言,例如 C、Objective-C、C#、PHP、Java、Python、IDL(Corba、Microsoft 和 UNO /OpenOffice 风格)、Fortran、VHDL 和某种程度的 D.

    Doxygen 可以导出到 HTML、LaTeX、RTF (MS-Word)、PostScript、超链接 PDF、压缩 HTML 和 Unix 手册页。文档直接从源代码中提取。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2020-05-19
      • 2011-03-11
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多