COM SDK参考文档应该用什么语法编写?[关闭]

您可以使用以下命令直接在IDL中编写文档 helpstring 属性-您代码的大多数消费者将能够使用例如OLE View或在他们的对象浏览器中直接读取它。我们公司编写了一个内部工具来提取helpstring文档,并将其转换为HTML格式的内部参考文档。

此外,您还可以使用以下工具 doxygen 记录界面-它将输出HTML、PDF、LaTeX等格式的文档。

IDL当然是一个很好的参考。但我想你会想提供代码示例和片段。

以下是一些想法:

• 它公开了什么样的COM接口?IDispatch、自定义、双?你可能是通过猜测你的SDK受众是谁,以及他们使用什么语言来做出这个决定的。

• 你应该只使用一种语言吗?也许你可以在C++中提供一些例子,在VB6中提供一些,在.NET中提供一些。NET(VB或C#)。

• 根据使用特定类型参数的难度(或缺乏难度)为给定示例选择语言。