.NET的最佳文档系统？ [英] Best documentation system for .NET?

问题描述

我以前没有使用过一个文件系统，通常手写注释。

I have not used a documentation system before and typically write comments by hand.

但是，我认为使用文档系统进行新的项目

However, I think it would be nice to use a document system for a new project.

你建议什么？我听说过 Sandcastle ，但我不知道这是否是最好的在这里。

What do you advise? I have heard of Sandcastle but I am not sure if it is the best thing out there.

（这是一个开源项目，所以它需要是免费的。）

(This is for an open-source project so it needs to be free.)

推荐答案

Sandcastle将使用HTML，HTML Help 1.x（.CHM）文件或HTML Help 2.x（.HxS）文件格式从代码中的XML注释中创建文档的MSDN完全可以与目录等进行搜索。

Sandcastle will create documentation in either HTML, HTML Help 1.x (.CHM) file or HTML Help 2.x (.HxS) file format from your XML comments in your code in the style of MSDN that is fully searchable with table of contents, etc..

理论上，为了获得非常完整的文档，您需要做的额外工作很少， 。它也可以使用样式表看起来完全不一样。

In theory there is very little work extra work you would need to do in order to get very fully documentation. It can also be styled using stylesheets to look completely different.

在 CodePlex 称为沙堡帮助文件生成器（ SHFB），可以帮助您使用Sandcastle构建/配置文档。

There is an application (free) on CodePlex called Sandcastle Help File Builder (SHFB) that can help you construct/configure the documentation using Sandcastle.

我个人使用过这一点，在我看来，使用SHFB进行配置很容易。如果要使用命令行，您还可以将其安排为自动构建过程的一部分进行重新构建。

I personally have used this and in my opinion it was easy to setup using SHFB to configure it. You can also schedule it to re-build as part of an automated build process if you want to use the command-line.

这篇关于.NET的最佳文档系统？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！