Warning: file_get_contents(/data/phpspider/zhask/data//catemap/4/sql-server-2008/3.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
如何从.NETDLL创建类的文档?_.net_Class_Documentation - Fatal编程技术网

如何从.NETDLL创建类的文档?

如何从.NETDLL创建类的文档?,.net,class,documentation,.net,Class,Documentation,我有一个专有的.NET DLL,没有需要使用的源代码。如何生成有关DLL公开的类的文档 我会寻找类似java的javadoc。使用,可能会与。它将生成文档HTML文件或Windows帮助文件 如果DLL附带有同名的Xml文件,则该文件甚至可能包含DLL的一些文本文档。否则,Sandcastle仍然会有帮助,因为它将生成类及其成员的概览,您可以通过单击链接从一种类型导航到另一种类型。在CodePlex的Sandcastle主页上注意: 微软不再积极开发Sandcastle CodePlex项目,因

我有一个专有的.NET DLL,没有需要使用的源代码。如何生成有关DLL公开的类的文档

我会寻找类似java的
javadoc

使用,可能会与。它将生成文档HTML文件或Windows帮助文件


如果DLL附带有同名的Xml文件,则该文件甚至可能包含DLL的一些文本文档。否则,Sandcastle仍然会有帮助,因为它将生成类及其成员的概览,您可以通过单击链接从一种类型导航到另一种类型。

在CodePlex的Sandcastle主页上注意:

微软不再积极开发Sandcastle CodePlex项目,因此,该网站今后将不会发布任何版本

现有的Sandcastle源代码已转移到Eric Woodruff的Sandcastle帮助文件生成器站点(移动到-->)。从现在开始,您应该在这个新位置下载最新版本。Eric将从现在起负责新版本的Sandcastle


更多的是对@ORMapper的回答的评论,但我无法发表评论(低于要求的50次重复)。

Sandcastle很好,我以前也用过。它与Doxygen相比如何?@CJ7:我还没有将Doxygen用于C#,因此无法提供全面的比较。我可以告诉你的是,Sandcastle只支持.NET/Mono程序集,它不生成类似于Doxygen的类图。我不确定Doxygen是与程序集一起工作还是只与源文件一起工作(因为Doxygen通常从源代码中提取文档注释本身-我不知道它是否也可以与二进制文件和编译器提取的Xml文档文件一起工作)。如果有任何Xml文档注释,它们很可能是为Sandcastle编写的,因为它实际上是C#doc comments的标准。SHFB是垃圾。它要求您引用系统上可能不存在的dll,如“Microsoft.Scripting.dll v1.1.0.20”-经过数小时的搜索,我可以找到用于ActiveX/COM的惊人文档生成器工具,但对于lame.NET程序集却没有,尽管您可以反映这些该死的东西。它们都依赖于您以XML格式构建文档。。。。那么为什么要使用这些工具呢???呃。@SanuelJackson:我不能对缺少的DLL说什么,但是我不确定你所说的“即使你可以反映该死的东西。它们都依赖于你以XML格式构建文档”是什么意思。反射只提供类和方法的公共接口,显然,它不能提供接口成员的任何描述。这就是XML文件的用途,它们包含由编译器从源代码中的文档注释(
//
)中提取的描述。在以前的库中,ActiveX/COM不容易通过反射公开,更直截了当地说,也不容易反转,因此构建文档更容易、更快。“即使您可以反映”,这意味着,我们现在能够收集对方法/类型/等的深入了解。请查看过去几天的一些工具,对于.NET,请尝试一下>“ForgeDoc v1.6”