元件的使用者協助
在撰寫元件時,您應將元件的相關協助及文件提供給您的使用者。 您可以透過描述性中繼資料 (Metadata) 在設計階段提供協助,也可以在執行階段呼叫 HTML 說明提供協助。
您可以透過使用 attributes 來提供您元件的描述性資訊。 屬性 (Attribute) 是一種附加在其他類別或類別成員的特定類別,並在編譯時期之際發出至中繼資料。 屬性 (Attribute) 可將資訊提供給使用者或是直接提供給開發環境。 例如,當附加至屬性 (Property) 或事件時,System.ComponentModel.DescriptionAttribute 屬性 (Attribute) 就會在 [屬性] 視窗顯示簡短的說明字串。 其他屬性 (Attribute) 則是影響開發環境對元件的運作方式。 例如,System.ComponentModel.BrowsableAttribute 屬性 (Attribute) 能夠決定屬性 (Property) 是否要顯示在 [屬性] 視窗當中。
元件通常不提供執行階段協助,但在某些情況下會提供。 例如,一個大型且複雜的元件可能需要內建的說明,如此開發人員就不需要撰寫整份文件。 .NET Framework System.Windows.Forms.Help 類別會封裝 HTML 說明 1.x 引擎,並且可以用來在執行階段使用 HTML 或 .chm 檔將說明提供給使用者。 如需詳細資訊,請參閱 HOW TO:指定您元件的說明檔。
在本節中
HOW TO:指定您元件的說明檔
說明如何在執行階段指定及顯示您元件的說明檔。HOW TO:提供關於元件的中繼資料描述
說明如何建立標準及自訂描述屬性 (Attribute) 並將其附加至您的元件。HOW TO:將中繼資料提供給元件屬性、方法及事件
說明如何將描述屬性 (Attribute) 附加至程式碼成員。
相關章節
- 擴充設計階段支援
提供將元件和控制項整合至設計環境的主題連結。