生成VS 2010的C＃的XML文档，HTML /帮助文件 [英] Generate HTML / Help files from VS 2010 C# XML documentation

问题描述

我要寻找一个很好的工具，从我的VS2010 XML文档创建HTML /帮助文件。我已经发现了一些商业工具，如

• 的。NET文档工具


• 的 VSDocman

我肯定有越多，我只列出这两个作为例子。还有一些简单的XSLT样式表绕到XML为HTML文档转换。

什么是你使用，例如有一个免费的工具进行转换，也许会加载。
我想弄清楚，基本上我已经发现两种类型的工具：

1. 的那些转换XML文档文件在不同的目标格式这是我所期待的。


2. 工具帮我生成的源代码中的XML文档。这不是（！）我所期待的。

感谢您的帮助。

---

的

沙堡/ SHFB组合的伟大工程。 。感谢所有谁帮助

一些言论：

1. NDoc的似乎是过时，最后更新是从2005年开始这就是为什么我跳过这个


2. 类似的线程，也很详细，可以在这里找到：的如何把C＃XML文档，注释成有用的东西？谢谢你的提示！


3. 有一些来源沙堡，最新的版本，我发现就设在这里： HTTP：//sandcastle.codeplex .COM /


4. 在为了产生 MsHelp2 我必须安装VS含2008 SDK hscomp.exe 。有一个1.0和1.1版本，据我可以算出它的版本1.0中包含的编译器。请参见 Helixsoft 并的Social MSDN 的一些细节。


5. 在我的情况下，生成的WebHelp不与Chrome的正常工作。它总是重新加载index.html页面。


6. 的的话题此处显示了如何命名空间的相关信息加入到沙塔文档


7. 更新截至2012年十一月的：对于较小的项目，我使用< A HREF =htt​​p://www.stack.nl/~dimitri/doxygen/> Doygen - 我觉得它更容易一些配置

$ b。 $ b

解决方案

我们正在使用的沙堡的转化和放大器;沙堡帮助文件生成器作为用户界面来管理帮助项目。在我看来，沙堡，并SHFB的美妙之处，认为一般的源代码文件旁边，您可以添加其他信息，如该计划，模式，必须遵循或项目中的任何附加的概念性内容不依赖的架构直接在程序中一个类。这可以通过创建与Microsoft创作模式的帮助下额外的xml文件来完成（可以使用Visual Studio为XML文件和架构为它可被编辑）。它很容易开始与这两种工具来像文档创建MSDN。

一个很久以前我试过含的DocBook这是近在技术方面是相同的（XML文件信息和XSLT文件将其转换为各种输出类型）。但它是对我们别无选择，因为没有转型，有可以使用Visual Studio生成的xml文档（加概念内容的转变是相当痛苦对我们来说）。

I am looking for a good tool creating HTML / Help files from my VS2010 XML documentation. I have found some commercial tools, such as

• .Net documentation tool
• VSDocman

I am sure there are more, I just list these two as examples. Also there are simple XSLT stylesheets around to convert the XML to HTML documentation.

What are you using, e.g. is there a free tool to do the conversion, maybe as Add-In. Just to clarify, basically I have found two types of tools:

1. The ones converting the XML documentation file in different target formats, this is what I am looking for.
2. Tools helping me to generate the XML documentation in the source code. This is not(!) what I am looking for.

Thanks for your help.

---

The Sandcastle / SHFB combo works great. Thanks to all who helped.

Some remarks:

1. NDoc seems to be outdated, last updates are from 2005. That's why I have skipped this.
2. A similar thread, also very detailed, can be found here: How to turn C# Xml Doc-Comments into something useful? Thanks for the hint!
3. There are some sources for Sandcastle, the latest version I have found is located here: http://sandcastle.codeplex.com/
4. In order to generate MsHelp2 I had to install VS 2008 SDK containing hscomp.exe. There is a version 1.0 and 1.1, as far as I could figure it out version 1.0 contains the compiler. See Helixsoft and Social MSDN for some details.
5. In my case the generated WebHelp does not work correctly with Chrome. It always reloads the index.html page.
6. The topic here shows how to add namespace infos into sandcastle documentation.
7. Update as of Nov 2012: For smaller projects I am using Doygen - I find it a little easier to configure.

解决方案

We are using Sandcastle for transformation & Sandcastle Help File Builder as a user interface to manage the help projects. In my opinion the beauty of the Sandcastle and SHFB is, that beside the "average" source code documentation, you can add additional information like architecture of the program, patterns that must be followed or any additional conceptional content for your project that is not tied directly to one class in your program. This can be done by creating additional xml files with the help of the Microsoft Authoring Schema (can be edited with visual studio as the xml file and the schema for it are available). Its pretty easy to start with those both tools to creating MSDN like documentation.

A long time ago I tried docbook which is nearly the same on the technical side (xml files containing the information and xslt files to transform it to various output types). But it was no option for us, because there is no transformation out there that can use the visual studio generated xml documentation (plus the transformation of conceptual content was pretty painful for us).

这篇关于生成VS 2010的C＃的XML文档，HTML /帮助文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！