从C＃项目创建文档。 [英] Creating Documentation from C# project.

问题描述

您好，

我是C＃的新手。我正在为C＃寻找类似于javadoc的工具，这样我就可以根据我在C＃代码中编写的注释创建自己的文档。我能够通过Visual Studio 2008从C＃代码文件创建XML文件。但是我不确定如何在此之后继续前进，以便我可以查看我创建的文档。有没有一个免费的工具，可以采取xml文件，然后创建一个类似于javadoc的漂亮的html文档？

非常感谢你帮助我。

Bye Bye
Mahesh

Hello,

I am a novice to C#. I was looking for a tool similar to javadoc for C# so that I can create my own documentation from the comments I write in the C# code. I was able to create the XML file from C# code files through Visual Studio 2008. But I am not sure how to proceed ahead after this so that I can view the documentation that I have created. Is there a free tool that can take the xml files and then create a nice html documentation similar to what javadoc does?

Thank you very much for helping me out.

Bye Bye
Mahesh

推荐答案

Hi Mahesh，

Microsoft创建了一个名为 Sandcastle ，可以为托管API生成HTML主题。它还将XML文档文件中的注释包含在它生成的主题中。

有关更多信息，请参阅 Sandcastle帮助。

您还应该尝试 DocProject 或< a href ="http://www.codeplex.com/SHFB"> Sandcastle帮助文件构建器，因为它们提供GUI和其他功能。他们还根据Sandcastle生成的主题自动构建编译HTML帮助1.x（.chm）和2.x（.HxS），但必须安装其他软件。

- Dave

Hi Mahesh,

Microsoft created a tool called Sandcastle that can produce HTML topics for managed APIs.  It will also include the comments from your XML documentation files into the topics that it generates.

For more information, see Sandcastle Help.

You should also try DocProject or Sandcastle Help File Builder since they provide GUIs and additional features.  They also build compiled HTML help 1.x (.chm) and 2.x (.HxS) automatically from the topics that Sandcastle generates, but additional software must be installed.

- Dave

这篇关于从C＃项目创建文档。的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！