0

C++ で記述された COM SDK があり、製品のドキュメントを作成したいと考えています。ほとんどの人はおそらくこの COM コンポーネントとの統合に C++ を使用しないでしょうが、多くの人はそうするでしょう。

C++ 開発者が知る必要のある詳細を失うことなく、API を記述するのに最適な方法はどれですか。

4

2 に答える 2

2

属性を使用して IDL にドキュメントを直接書き込むことがhelpstringできます。コードのほとんどのコンシューマは、OLE ビューやオブジェクト ブラウザなどを使用して直接これを読み取ることができます。当社は、ヘルプストリング ドキュメントを抽出し、それを HTML の内部参照ドキュメントに変換する内部ツールを作成しました。

また、 doxygenなどのツールを使用してインターフェースを文書化することもできます。これは、HTML、PDF、LaTeX などの形式の文書を出力します。

于 2008-10-21T06:26:39.697 に答える
2

IDL は確かにリファレンスとしては良い考えです。しかし、コード例とスニペットを提供したいと思うでしょう。

ここにいくつかの考えがあります：

  • どの種類の COM インターフェイスが公開されていますか? IDispatch、カスタム、デュアル? おそらく、SDK の対象者が誰で、どの言語を使用しているかを推測して、この決定を下したことでしょう。

  • 1 つの言語だけを使用する必要がありますか? C++、VB6、.NET (VB または C#) でいくつかの例を提供できるかもしれません。

  • その言語で特定のタイプの引数を使用する難しさ (または難しさ) に基づいて、特定の例の言語を選択します。

于 2008-10-21T06:36:56.400 に答える