.Net XML 注释到 API 文档中
有没有一种简单的方法可以从 Visual Studio XML 输出生成 MSDN 风格的文档？
我没有足够的耐心来为其设置一个好的 xslt，因为我知道我不是第一个跨过这座桥的人。
另外，我最近尝试建立沙堡，但这确实让我眼花缭乱。 要么我在这个过程中遗漏了一些重要的东西，要么它太复杂了。
我知道有人有一个非常好的简单解决方案。
我在这里重申是因为我认为我的格式使该段落不吸引人阅读：
我尝试了 sandcastle，但设置起来非常困难。 我真正想到的是简单得多的事情。
也就是说，除非我只是不了解沙堡过程。 对我来说，仅仅为了给测试人员提供一些好用的东西似乎是一个巨大的额外负担。
Is there an easy way to produce MSDN-style documentation from the Visual Studio XML output?
I'm not patient enough to set up a good xslt for it because I know I'm not the first person to cross this bridge.
Also, I tried setting up sandcastle recently, but it really made my eyes cross. Either I was missing something important in the process or it is just way too involved.
I know somebody out there has a really nice dead-simple solution.
I'm reiterating here because I think my formatting made that paragraph non-inviting to read:
I gave sandcastle a try but had a really hard time getting it set up.
What I really have in mind is something much simpler.
That is, unless I just don't understand the sandcastle process. It seemed like an awful lot of extra baggage to me just to produce something nice for the testers to work with.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（6）
看看 Sandcastle，它正是这样做的。 它也是更简单的解决方案之一，并且或多或少是首选工具，因此从长远来看，如果您指定在设置过程中遇到了什么问题，也许我们可以帮助您设置 Sandcastle？
Have a look at Sandcastle, which does exactly that. It's also one of the more simpler solutions out there, and it's more or less the tool of choice, so in the long run, maybe we could help you to set up Sandcastle if you specify what issues you encountered during setup?
我刚刚再次设置了 Sandcastle。 尝试安装它（2008 年 5 月版本）并搜索 SandcastleGui.exe 或类似的东西（它位于示例文件夹左右）。
单击“添加程序集”并添加一个或多个程序集，添加任何 .xml 文档文件（如果启用该选项，则由编译器生成的文件），然后“构建”。
这需要一些时间，但结果是值得付出努力的。 它实际上会从 MSDN 中查找内容，因此生成的文档还将具有一直到 System.Object 的类继承，并带有指向 MSDN 和内容的链接。
Sandcastle 乍一看似乎有点复杂，尤其是当您想在自动化构建中使用它时，但我绝对相信它值得付出努力。
还可以看看 Sandcastle Help File Builder，这是一个更高级的 GUI。
I've just set up Sandcastle again. Try installing it (the May 2008 release) and search for SandcastleGui.exe or something similar (it's in the examples folder or so).
Click Add Assembly and add your Assembly or Assemblies, add any .xml Documentation files (the ones generated by the compiler if you enabled that option) and then Build.
It will take some time, but the result will be worth the effort. It will actually look up stuff from MSDN, so your resulting documentation will also have the Class Inheritance all the way down to System.Object with links to MSDN and stuff.
Sandcastle seems a bit complicated at first, especially when you want to use it in an automated build, but I am absolutely sure it will be worth the effort.
Also have a look at Sandcastle Help File Builder, this is a somewhat more advanced GUI for it.
您还应该使用 Sandcastle 帮助文件生成器。 它为您提供了一个类似 ndoc 的 GUI，用于生成帮助文件，因此您无需在命令提示符下执行任何操作。
欢迎来到 Sandcastle 帮助文件生成器项目
You should also use the Sandcastle Help File Builder. It provides you with a ndoc like GUI for generating help files so you don't have to do anything from a command prompt.
Welcome to the Sandcastle Help File Builder Project
按照 这篇简单的 5 步文章，您就差不多完成了。 作为奖励，您可以使用 H2Viewer 查看 Html 帮助 2.x 文件。
Follow this simple 5 step article and you are pretty much done. As a bonus you can use H2Viewer to view Html Help 2.x files.
我使用 NDoc3
I use NDoc3
您正在寻找 Sandcastle
项目页面：Sandcastle 版本
博客：Sandcastle 博客
NDoc Code Documentation Generator for .NET 曾经是首选工具，但支持几乎停止了。
You're looking for Sandcastle
Project Page: Sandcastle Releases
Blog: Sandcastle Blog
NDoc Code Documentation Generator for .NET used to be the tool of choice, but support has all but stopped.