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

是否有用于C#代码的类似工具?

它必须是免费的,理想的开源软件。

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

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

评论

我们使用沙堡帮助文件生成器(SHFB)。功能强大且免费,您可以同时生成.chm帮助和html。

#1 楼

您可以使用普通的Microsoft C#编译器执行此操作。虽然它不是开源的。显然,它是免费的,因为它使用了已有的工具。
对于名为XMLsample.cs的C#文件,

csc XMLsample.cs /doc:XMLsample.xml


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

请参见MSDN


它也可在Mono C#编译器上使用。 Mono C#是免费的开放源代码。

mcs XMLsample.cs /doc:XMLsample.xml


请参见Mono手册页

评论


如果没有Main()方法,则无法生成C#文件的文档。还有其他命令吗?

– Rupendra
17年7月7日上午9:55

有关软件使用的@Riky问题更适合于超级用户,或者在这种情况下为stackoverflow

–林登·怀特(Lyndon White)
18-2-23在3:12

#2 楼

Doxygen似乎适合您。



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



它可用于生成C#文档以及其他语言,例如C,Objective-C,PHP,Java,Python。

评论


我刚刚尝试过Doxygen,它就像一种魅力,非常感谢!

–卢克
19年11月22日在14:21

#3 楼

放入2c是因为遵循了公认的答案,但事实证明,Microsoft C#编译器仅完成了一半工作。即,它只给您一个xml文件。但是要拥有一个不错的网站,您仍然必须在网站上应用一些样式表,这才是桥梁被打破的地方-Microsoft C#编译器无法做到这一点,而Microsoft支持的工具可以做到这一点,Sandcastle Microsoft不再积极开发CodePlex项目。

总而言之,已接受的答案可能对2014年有效,但对2017年则不再有效。

新的答案是Eric Woodruff的Sandcastle帮助文件生成器网站,网址为https: //GitHub.com/EWSoftware/SHFB,这是基于现有Sandcastle源代码的分支。

#4 楼

我们使用文件! X,对我们来说真的很好。您可以从注释和样式表中获得完整的API文档,使其看起来非常漂亮。他们对支持也很敏感。

话说回来,这不是免费的。但是对于它提供的功能,我认为这是值得的。 (我们以前使用的是免费程序,而不是doxygen,最终花费了太多时间。)