接口的帮助字符串应包含什么

What should helpstring of the interface contain?

本文关键字：包含 什么 字符串 帮助 接口      更新时间：2023-10-16

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

[
    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时，您是否遵循任何准则。

我知道没有指导方针。 我见过很多"我的界面"形式的，这是无用的。

如果您了解您的目标受众（内部开发人员、经验丰富的第三方开发人员、IT 人员等），请考虑他们可能具备哪些技能（并且可能需要使用您的界面）以及什么会对他们有所帮助。

相关文章：