2

我正在尝试为我们的供应商之一为我们正在集成的应用程序提供的 Web 服务编写一些文档。一堆接口是在 Web 服务本身中定义的自定义对象。供应商强烈反对为此应用程序提供任何文档，因此我自己承担了为他们完成工作的责任[根据我更好的判断]。

他们坦率地提供的文档令人尴尬，我正在尝试尽可能短地完成这些工作，以便将一些高质量的文档放在一起。我知道，由于我无法访问他们的源代码，我不能只通过 nDoc/Sandcastle 运行它来吐出 API 文档，但我想知道（作为中途之家）是否有一种简单的方法来将智能感知导出到文本文件，而无需编写实用程序来专门迭代定义的每个对象类型并将成员反映到文本中？

如果我能做到这一点，它至少可以确保我有一个高质量的文档结构，我可以在其中填写空白。必须来回跳到 Visual Studio 来检查每个班级成员的智能感知是一种非常费力的方法。

有没有人有任何想法？

4

7 回答 7

6

如果它是您尝试记录的 Web 服务，那么您不能解析出 WSDL 吗？

于 2009-01-14T22:03:12.003 回答
3

如果您正在访问远程 Web 服务，那么我认为您可以访问相应的 WSDL：如何解析它并仅查找您需要的信息？或者使用工具来做到这一点（我用谷歌搜索“wsdl 文档生成器”）？或者甚至使用 WSDL.exe 从 WSDL 生成一些虚拟代码，然后记录它，也许是 GhostDoc 的帮助？高温高压

于 2009-01-14T22:13:22.123 回答
2

您可以使用反射来转储方法等吗？

反射是 .Net 中的特性，它使我们能够在运行时获取有关对象的一些信息。该信息包含类的数据。它还可以获取该对象的类和构造函数内部的方法的名称。

于 2009-01-14T21:45:34.880 回答
1

我认为 VS.net 为智能感知生成文档。对于现有程序集，它已经在您的文件系统上（例如 C:\Windows\Microsoft.NET\Framework\v2.0.50727\en）

尝试在 VS.NET 中使用供应商提供的程序集。使用进程资源管理器或 sysinternals 中的任何此类工具来查看正在加载哪些文件。我敢肯定，您会发现为自定义程序集创建了一个 xml 文件（用于显示 Intellisense 和可用的文档）。

希望有帮助。

编辑：我认为同一个文件夹（您的自定义程序集所在的位置）将包含用于文档的 xml 文件。

于 2009-01-14T22:01:45.643 回答
0

如果你有 dll，你能不反编译它们然后重新编译并使用 nDoc 吗？这应该给你一个合理的开始。

于 2009-01-14T21:47:24.237 回答
0

您能否仅使用反射器（来自 redgate）来查看程序集（反编译）而不是复制 API 文档。我不确定你会得到什么来反映和构建你在反射器中看不到的文档（当然这取决于他们编写的可读代码。

于 2009-01-14T21:58:08.630 回答
0

也许这很疯狂，但是您能否截取完整列表的屏幕截图，并通过 OCR 程序运行它？

于 2009-01-14T21:58:48.940 回答