應該寫什麼語法的COM SDK參考文檔？

Question

我有一個用C++編寫的COM SDK，我想爲我的產品創建文檔。據我所知，大多數人可能不會使用C++來與這個COM組件集成，但很多人會這樣做。

哪種方法最適合描述API，而不會丟失C++開發人員需要知道的細節。

Answer 1

您可以使用helpstring屬性直接在IDL中編寫文檔 - 您的代碼的大多數用戶將能夠使用例如OLE視圖或其對象瀏覽器直接讀取該文檔。我們公司編寫了一個內部工具來提取幫助文檔，並將其轉化爲HTML中的內部參考文檔。

此外，您可以使用像doxygen這樣的工具來記錄界面 - 它將輸出HTML，PDF，LaTeX等格式的文檔。

Answer 2

IDL肯定是一個參考的好主意。但我想你會想提供代碼示例和片段。

這裏有幾個想法：

• 它暴露出什麼樣的COM接口的？ IDispatch，自定義，雙重？您可能通過猜測您的SDK受衆是誰做出了決定，因此他們使用的是什麼語言。

• 您是否應該只使用一種語言？也許你可以用C++提供一些例子，一些用VB6，一些用.NET（VB或C＃）。

• 根據難度（或缺乏）使用該語言中特定類型的參數來選擇給定示例的語言。