为C#代码创建html文档

Question

为C#代码创建html文档

jah*_*aho 55 c# documentation visual-studio

我正在开发一个C#项目,VisualAssist /// <summary></summary>为我生成这些花哨的评论,我一直在使用它们来记录我的代码.

我假设必须有一种方法可以使用这些注释来创建像Doxygen或Javadoc那样的HTML文档.我怎么做？

Answer 1

Doxygen或Sandcastle帮助文件构建器是将XML文档提取为HTML(和其他形式)外部文档的主要工具.

请注意,您可以将这些文档导出程序与文档生成器结合使用 - 正如您所发现的,Resharper有一些基本的帮助程序,但是还有更多高级工具可以执行此特定任务,例如GhostDoc(用于带有XML文档的C#/ VB代码) )或我的addin Atomineer Pro文档(适用于C#,C++/CLI,C++,C,VB,Java,JavaScript,TypeScript,JScript,PHP,包含XML,Doxygen,JavaDoc或Qt文档的Unrealscript代码).

Answer 2

mod*_*777 29

在2017年,最接近Javadoc的东西可能是由微软开发的DocFx,它既是Commmand-Line-Tool又是VS2017插件.

它的边缘仍然有点粗糙,但看起来很有希望.

另一种选择是Wyam,它具有适用于净应用的文档配方.查看蛋糕文档以获取示例.

注意：docFX 作为一个项目已经死了（突出的错误修复/补丁现在已经等待了 2 年多了，并且它依赖于像 wkhtmltopdf 这样的上游库，这些库在 2 年多前就停止维护并且不再运行）。一年多来，官方页面一直在说“我们有内部使用的替代品，但我们还没有让其他人拥有它”。不要在上面浪费时间！ (4认同)
不幸的是，DocFX 有一个很大的缺点，它只关注公众的文档。所以如果你想做一些内部使用的文档，其中还包括访问修饰符“internal”或“private”，那是绝对没用的。当然......你有机会自己修改代码并解决这个问题。请参阅：https://github.com/dotnet/docfx/issues/836 (2认同)

归档时间：	12 年，11 月前
查看次数：	83783 次
最近记录：	8 年前