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 人员等），请考虑他们可能拥有的技能（并且可能需要使用您的界面）以及对他们有帮助的技能。