什么工具可以从 C# 代码生成 HTML 文档,就像 Javadoc 可以为 Java 做的那样?

软件推荐 视窗 linux html C# 文档生成器
2021-10-13 21:36:13

Java 开发人员可以轻松地从他们的 Java 代码生成 HTML 文档,这是一种在线发布 API 的便捷方式。是一个例子。

C#代码有类似的工具吗?

它必须是免费的,最好是开源的。

至少必须在 Windows 和 Linux 上运行。

不需要 HTML 框架,只生成一个长 HTML 页面的工具也是完美的。

4个回答

您可以使用普通的 Microsoft C# 编译器执行此操作。虽然它不是开源的。辩论它是免费的,因为它使用你已经拥有的工具。

对于 C# 文件调用XMLsample.cs

csc XMLsample.cs /doc:XMLsample.xml

将产生 xml 文件XMLsample.xml通过对此应用样式表,您将拥有一个不错的网站。CSS 应该可以,但要进行更重要的重新格式化,您可能需要使用 XSLT。

见 MSDN


它也可用于 Mono C# 编译器。Mono C#免费和开源的。

mcs XMLsample.cs /doc:XMLsample.xml

请参见 Mono 联机帮助页

Doxygen似乎对你有用。

  • 它可以从一组文档源文件中生成在线文档浏览器(HTML)和/或离线参考手册($\mbox{\LaTeX}$)。
  • 还支持在 RTF (MS-Word)、PostScript、超链接 PDF、压缩 HTML 和 Unix 手册页中生成输出。
  • 文档直接从源代码中提取,这使得文档与源代码保持一致变得更加容易。

它可用于从 C# 以及其他语言(如 C、Objective-C、PHP、Java、Python)生成文档。

放入我的 2c,因为我遵循公认的答案,但事实证明,

Microsoft C# 编译器只是做了半生不熟的工作。即,它只给你一个 xml 文件。但是要拥有一个漂亮的网站,您仍然需要对其应用一些样式表,这就是桥梁被打破的地方——Microsoft C# 编译器不这样做,而微软支持的工具可以做到这一点,Sandcastle CodePlex 项目,不再由 Microsoft 积极开发。

总而言之,公认的答案可能对 2014 年有利,但对 2017 年不再有利。

新的答案是 Eric Woodruff 的Sandcastle Help File Builder站点,网址为https://GitHub.com/EWSoftware/SHFB,它是基于现有 Sandcastle 源代码的分支。

我们使用文档!X,它对我们来说非常有效。您可以从评论中获得完整的 API 文档,并且它的样式表使它看起来非常非常漂亮。他们对支持也非常敏感。

话虽如此,它不是免费的。但就它所提供的东西而言,我认为这是非常值得的。(我们之前使用的是免费程序,而不是 doxygen,但最终花费的时间太贵了。)