我正在尝试为我们正在集成的应用程序中的某个供应商提供的Web服务编写一些文档。一堆接口是Web服务本身定义的自定义对象。供应商对提供此应用程序的任何文档都提出了很大的阻力,所以我自己也为他们做了工作[反对我更好的判断]。
他们 提供的文档坦率地说是令人尴尬的,我正在尝试做一些简短的工作,因为我可以将一些优质的文档放在一起。我知道,由于我无法访问他们的源代码,我不能通过nDoc / Sandcastle运行它来吐出API文档,但我想知道是否(作为一个中途的房子)有一个简单的方法将intellisense导出到文本文件而不必编写实用程序来特定地迭代定义的每个对象类型并将成员反映到文本中?
如果我能做到这一点,至少可以确保我有一个高质量的文档结构,我可以填写空白。必须来回跳过Visual Studio来检查每个班级成员的智能感知是一种非常费力的方法。
有没有人有任何想法?
答案 0 :(得分:6)
如果它是您尝试记录的Web服务,那么您是否无法解析出WSDL?
答案 1 :(得分:3)
如果您正在访问远程Web服务,那么我认为您可以访问相应的WSDL:如何解析它并查找您需要的信息? 或使用工具执行此操作(我用Google搜索“wsdl文档生成器”)? 或者甚至使用WSDL.exe从WSDL生成一些虚拟代码然后记录它,也许是由GhostDoc帮助的? HTH
答案 2 :(得分:2)
你可以使用Reflection来转储方法等吗?
反射是.Net中的功能,它使我们能够在运行时获取有关对象的一些信息。该信息包含该类的数据。它还可以获取类中的方法的名称以及该对象的构造函数。
答案 3 :(得分:1)
我认为VS.net会生成intellisense的文档。对于现有程序集,它已经在您的文件系统上(例如C:\ Windows \ Microsoft.NET \ Framework \ v2.0.50727 \ en)
尝试在VS.NET中使用供应商的程序集。使用进程资源管理器或sysinternals中的任何此类工具来查看正在加载的文件。我相信,你会发现有一个为自定义程序集创建的xml文件(用于显示Intellisense和随其可用的文档)。
希望有所帮助。
编辑:我认为同一个文件夹(自定义程序集所在的文件夹)将包含文档的xml文件。
答案 4 :(得分:0)
如果你有dll,你可以不反编译然后重新编译并使用nDoc吗?这应该给你一个合理的开始。
答案 5 :(得分:0)
您是否可以使用reflector (from redgate)查看程序集(反编译)而不是复制API文档。我不确定你还能反映和构建你不会在反射器中看到的文档:当然这取决于他们的写作可读代码。
答案 6 :(得分:0)
也许这很疯狂,但您可以截取完整列表的截图,并通过OCR程序运行吗?