界面的帮助字符串应包含哪些内容？

Question

我观察到不同的开发商有不同的选择文本在帮助字符串指定。一些例子，

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

我不知道这helpstring在所有有用的（！？）。

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