Documentazione relativa ai componenti
È opportuno che l'autore dei componenti fornisca agli utenti anche documentazione relativa ai componenti creati. È possibile fornire documentazione in fase di progettazione mediante metadati descrittivi e in fase di esecuzione mediante la Guida HTML.
È possibile fornire informazioni descrittive relative ai componenti mediante l'uso di attributes. Gli attributi sono classi specializzate associate ad altre classi o membri di classi e vengono inseriti in metadati in fase di compilazione. Gli attributi possono fornire informazioni all'utente o direttamente all'ambiente di sviluppo. Ad esempio, l'attributo System.ComponentModel.DescriptionAttribute, quando è associato a una proprietà o a un evento, consente la visualizzazione di una breve stringa descrittiva nella finestra Proprietà. Altri attributi influenzano l'interazione dell'ambiente di sviluppo con il componente. L'attributo System.ComponentModel.BrowsableAttribute consente ad esempio di determinare se una proprietà deve essere visualizzata nella finestra Proprietà.
L'assistenza in fase di esecuzione non viene generalmente fornita da un componente, ma in alcuni casi può essere opportuna. È possibile ad esempio che in un componente complesso e di grandi dimensioni sia presente una Guida incorporata, per cui gli sviluppatori non dovranno scrivere una documentazione estesa. Nella classe System.Windows.Forms.Help di .NET Framework, che può essere utilizzata per fornire una Guida agli utenti in fase di esecuzione con file HTML o CHM, è incapsulato il motore HTML Help 1.x. Per informazioni dettagliate, vedere Procedura: specificare un file della Guida per un componente.
In questa sezione
Procedura: specificare un file della Guida per un componente
Viene illustrato come specificare e visualizzare un file della Guida per il componente in fase di esecuzione.Procedura: specificare descrizioni di metadati relative al componente
Viene illustrato come creare e associare attributi descrittivi standard e personalizzati al componente.Procedura: specificare metadati per proprietà, metodi ed eventi di un componente
Viene descritto come associare attributi descrittivi a membri del codice.
Sezioni correlate
- Estensione del supporto in fase di progettazione
Vengono forniti collegamenti ad argomenti relativi all'integrazione dei componenti e dei controlli nell'ambiente di progettazione.