如何将C＃的XML文档，注释成有用的东西？ [英] How to turn C# Xml Doc-Comments into something useful?
问题描述
我想要编译从一个大项目的XML文档说明成某种形式，很容易阅读和搜索，希望能更方便的浏览比原始源$ C $ C。我不是特别担心年底格式 - CHM，HTML，XYZ - 只要它是可用的。如果能够轻松地滚动（或链接）附加内容将是一个加号。
I want to compile the Xml documentation from a large project into some form that's easy to read and search, hopefully more convenient than browsing the raw source code. I'm not particularly worried about the end format - CHM, HTML, xyz - as long as it's usable. Being able to easily roll in (or link to) additional content would be a plus.
曾经是事实上的标准，但该项目表明没有任何生命迹象的电流 NDoc的（最后更新我可以看到的是19 2005年2月）。
NDoc used to be the de facto standard, but that project shows no current sign of life (last update I can see is 19 February 2005).
沙堡似乎取代NDoc的为共同的标准，但我从来没有设法得到它运行可靠，这太似乎是一个死项目。 （上次发布2008年5月），但答案这个问题似乎表明它没有准备火化。
Sandcastle seemed to supplant NDoc as the common standard, but I never did manage to get it running reliably, and this too seems to be a dead project. (Last release May 2008), though answers to this question seem to indicate it's not yet ready for cremation.
什么的现在打开XML文档，评论，从一个大的C＃项目成某种形式的参考材料的好方法？的
What's now a good way to turn the Xml Doc-Comments from a large C# project into some form of reference material?
相关问题：
- What are the C# documentation tags?
- XML Code Comments in .NET
- Is SandCastle a dead project ?
我在任何有新的.Net 4.0善良的支持，我们会迁移上面提到的大项目特别感兴趣。此外，虽然我倒是preFER一些开源的，或者至少是免费的，任何商业选项将被检查出来为好。
I'm particularly interested in anything that has support for new .Net 4.0 goodness, as we'll be migrating the "large project" mentioned above. Also, while I'd prefer something open source, or at least free, any commercial options would be checked out as well.
推荐答案
沙堡仍然存在......这是真的出现了两年没有发布，而是一个新的版本是迫在眉睫，的according上的沙堡网站的讨论。它已经推迟，但我想它也将很快面市。预计支持.NET 4中，并且是免费的，开源的。
Sandcastle is still around...it's true there has been no release in two years, but a new release is imminent, according to a discussion on the Sandcastle site. It's been delayed, but I imagine it will be available soon. It is expected to support .NET 4, and is free and open source.
至于用沙堡，我发现这是非常棘手开始使用。经过大量的试验和错误，我有一个体面的工作流程产生类似于从MSDN XML注释code文档。 我写在我的网站的过程中前一阵子，如果你是热衷于尝试一次。
As far as using Sandcastle, I found it to be tricky to start using. After much trial and error, I got a decent workflow for generating code documentation similar to MSDN from XML comments. I wrote up the process on my site a while ago, if you're keen to try again.
还有实况，一个轻量级的和基本的文档生成。它简单易用，所以也许你可以给一个尝试为好。
There is also docu, a lightweight and basic documentation generator. It's simple to use, so maybe you could give that a try as well.
这篇关于如何将C＃的XML文档，注释成有用的东西？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
