c++ - インターフェイスのヘルプ文字列には何を含める必要がありますか？

Question

開発者が異なれば、ヘルプ文字列で指定するテキストの選択肢も異なります。いくつかの例、

[
    helpstring ("My Interface"),
]
interface MyInterface : IUnknown
{
}

このヘルプストリングがまったく役立つかどうかはわかりません（！？）。

[
    helpstring ("Interface used with Module A to do some stuff."),
]
interface MyInterface : IUnknown
{
}

良い？

[
    helpstring ("Used to implement certain functionality."),
]
interface MyInterface : IUnknown
{
}

他の多く。

helpstringインターフェースを指定する際に従うガイドラインはありますか？

Answer 1

私が知っているガイドラインはありません。役に立たない「マイインターフェイス」の形式の多くを見てきました。

ターゲットオーディエンス（社内開発者、経験豊富なサードパーティ開発者、ITスタッフなど）を知っている場合は、彼らが持つ可能性のあるスキル（およびおそらくインターフェイスを使用するために必要なスキル）と、彼らに役立つものを考えてください。