我观察到不同的开发人员对帮助字符串中指定的文本有不同的选择。一些例子,
[
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
{
}
还有很多。
在指定接口(interface)的 helpstring
时,您是否遵循任何准则。
最佳答案
据我所知,没有任何准则。我见过很多都是“我的界面”形式的,没用。
如果您了解您的目标受众(内部开发人员、经验丰富的第三方开发人员、IT 人员等),请考虑他们可能拥有哪些技能(并且可能需要使用您的界面)以及什么可以帮助他们。
关于c++ - 接口(interface)的helpstring应该包含什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/10876975/