接口的helptring包含什么?

时间:2012-06-04 06:08:08

标签: c++ interface idl

我观察到不同的开发人员在帮助字符串中指定了不同的文本选择。一些例子,

[
    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时是否有任何指南。

1 个答案:

答案 0 :(得分:1)

我不知道有任何指导方针。我见过许多“我的界面”形式,这是没用的。

如果您了解目标受众(内部开发人员,经验丰富的第三方开发人员,IT员工等),请考虑他们可能具备的技能(可能需要使用您的界面)以及对他们有何帮助。< / p>