我正在寻找一个从我的VS2010 XML文档中创建HTML /帮助文件的好工具。我找到了一些商业工具,例如

我确定还有更多,我只是列出这两个例子。另外,周围还有简单的XSLT样式表,可以将XML转换为HTML文档。

您正在使用什么,例如,是否有一个免费的工具可以进行转换,也许是附加工具。只是为了澄清,我基本上找到了两种类型的工具:

  1. 以不同的目标格式转换XML文档文件的文件,这就是我想要的。
  2. 工具帮助我在源代码中生成XML文档。这不是(!)我想要的。

谢谢你的帮助。


Sandcastle / SHFB组合效果很好。感谢所有帮助的人。

一些评论:

  1. NDOC似乎已经过时了,最后更新是从2005年开始的。这就是为什么我跳过了这一点。
  2. 相似的线程(也非常详细)可以在此处找到: https://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-doc-comments-into-something-use-useful 感谢您的提示!
  3. 有一些Sandcastle的来源,我发现的最新版本位于这里: http://sandcastle.codeplex.com/
  4. 为了生成 MsHelp2 我不得不安装vs 2008 SDK包含 hscomp.exe. 。据我所知,有1.0版和1.1版,版本1.0包含编译器。看 Helixsoft社交MSDN 有关一些细节。
  5. 就我而言,生成的WebHelp无法正确使用Chrome。它总是重新加载index.html页面。
  6. 主题在这里 显示如何将名称空间Infos添加到Sandcastle文档中。
  7. 截至2012年11月的更新:对于较小的项目,我正在使用 doxygen - 我发现配置更容易。
有帮助吗?

解决方案

我们正在使用Sandcastle进行转换和Sandcastle帮助文件构建器作为用户界面来管理帮助项目。我认为,沙堡和SHFB的美丽是,除了“平均”源代码文档之外,您还可以添加其他信息,例如该程序的架构,必须遵循的模式或项目的任何其他构思内容直接进入您程序中的一个课程。这可以通过在Microsoft创作架构的帮助下创建其他XML文件来完成(可以用Visual Studio作为XML文件编辑,并且可以使用该模式)。从两个工具创建MSDN类似文档的工具开始非常容易。

很久以前,我尝试了在技术方面几乎相同的DocBook(XML文件包含信息和XSLT文件以将其转换为各种输出类型)。但这对我们来说是没有选择的,因为没有转换可以使用视觉工作室生成的XML文档(加上概念内容的转换对我们来说非常痛苦)。

其他提示

另外两个免费工具,可以从XML注释中创建文档:

Sandcastle + SHFB是一个很棒的组合。免费并生成HTML,CHM等

许可以下: CC-BY-SA归因
不隶属于 StackOverflow
scroll top