如何将C＃Xml Doc-Comments转换成有用的东西？ [英] How to turn C# Xml Doc-Comments into something useful?

问题描述

我想将Xml文档从大型项目编译成易于阅读和搜索的形式，希望比浏览原始源代码更方便。只要可用，我并不特别担心最终格式 - 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 曾经是事实上的标准，但该项目没有显示现在的生活迹象（最后一次更新可以看到是2005年2月19日）。

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).

Sandcastle 似乎取代了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 Doc-Comments从一个大型C＃项目转换成某种形式参考资料？

What's now a good way to turn the Xml Doc-Comments from a large C# project into some form of reference material?

相关问题：

• 什么是C＃文档标签？


• < a href =https://stackoverflow.com/questions/757844/xml-code-comments-in-net> .NET中的XML代码注释


• SandCastle是否是一个死亡项目？

• What are the C# documentation tags?
• XML Code Comments in .NET
• Is SandCastle a dead project ?

我对任何支持新的.Net 4.0优点的东西感兴趣，因为我们将迁移大项目提到波夫。另外，虽然我更喜欢某些开放源码，或至少是免费的，但任何商业选项也将被检出。

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.

推荐答案

沙堡仍然在...这是真的，两年来一直没有发布，但是一个新的版本即将来临，根据Sandcastle网站的讨论。这已经被推迟了，但我想象将会很快提供。预计将支持.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.

就使用Sandcastle而言，我发现使用起来很棘手。经过多次尝试和错误，我从XML注释中获得了类似于MSDN的代码文档的体面工作流程。 我在我的网站上写了一个过程如果你很想再试一次。

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.

还有一个 docu ，一个轻量级和基本的文档生成器。使用起来很简单，所以也许你可以尝试一下。

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 Doc-Comments转换成有用的东西？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！