Помощь пользователю по компонентам
Авторы компонентов должны предоставлять пользователям компонентов помощь и документацию. Помощь пользователю предоставляется во время разработки при помощи описательных метаданных, а в ходе выполнения компонента — путем вызова HTML-справки.
Описание компонентов может предоставляться при помощи attributes. Атрибуты представляют собой специализированные классы, которые присоединяются к другим классам или членам классов и преобразуются в метаданные во время компиляции. Атрибуты могут содержать сведения, предназначенные для пользователя или непосредственно для среды разработки. Например, атрибут System.ComponentModel.DescriptionAttribute, присоединенный к свойству или событию, выводит в окне "Свойства" короткую строку с их описанием. Другие атрибуты изменяют способ работы с компонентом в среде разработки. Например, атрибут System.ComponentModel.BrowsableAttribute определяет, будет ли свойство отображаться в окне "Свойства".
Компонент не всегда поддерживает помощь во время выполнения, но бывают случаи, когда это необходимо. Например, очень большой и сложный компонент может иметь встроенную справку, чтобы использующим его разработчикам не пришлось читать обширную документацию. Класс .NET Framework System.Windows.Forms.Help включает в себя ядро HTML Help 1.x. Этот класс может использоваться во время выполнения компонента для организации справки для пользователей на основе HTML- или CHM-файлов. Дополнительные сведения см. в разделе Практическое руководство. Указание файла справки для компонента.
В этом подразделе
Практическое руководство. Указание файла справки для компонента
Описание порядка указания и вывода на экран файла справки компонента во время выполнения.Практическое руководство. Предоставление описаний компонента в форме метаданных
Демонстрация создания и присоединения к компоненту стандартных и пользовательских описательных атрибутов.Практическое руководство. Предоставление метаданных для свойств, методов и событий компонента
Описание порядка присоединения описательных атрибутов к элементам кода.
Связанные подразделы
- Расширение поддержки времени разработки
Ссылки на разделы, посвященные интеграции компонентов и элементов управления в среду разработки.