В чем должна помочь строка интерфейса?

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

Нет никаких рекомендаций, о которых я знаю. Я видел многих, которые имеют форму «Мой интерфейс», которая бесполезна.

Если вы знаете свою целевую аудиторию (разработчики дома, опытные сторонние разработчики, ИТ-персонал и т. Д.), Подумайте о том, какие навыки они, вероятно, будут иметь (и, возможно, потребуется использовать ваш интерфейс) и что им поможет.