經過了前兩篇之後,這次咱們來瞧瞧一個類別說明的主要頁面。
上圖是一個我將樹狀節點先收起來的圖,這個圖是System.Windows.Forms.TextBox類別的說明首頁(http://msdn.microsoft.com/zh-tw/library/system.windows.forms.textbox.aspx),上半段的一些說明在前一篇已經提到過,在此不再贅述。各位網友可以在畫面上看到幾個節點:語法、備註、範例、繼承階層架構、執行緒安全、平台、版本資訊與請參閱;這些節點不盡然在每個類別都會相同,以下會談到某些節點的說明。
1. 語法:語法其實只在說明如何宣告以這個類別為參考的物件,重要的一點是通常它只說明宣告,而不是建立執行個體。
2. 備註:備註通常會有許多額外的提示,不要被「備註」二字所騙而以為這個一點都不重要,以這個TextBox的備註而言,就講解了一些TextBox的特別技巧。
另一個備註尤其重要的地方在於當你使用的類別出現了可怕的「請注意:這個方法現在已經過時。」或 「請注意:這個 API 現在已經過時。」的狀況下,備註的內容就會告訴我們該用哪一種新的方式來取代,例如以下這個畫面(http://msdn.microsoft.com/zh-tw/library/system.web.ui.page.registerarraydeclaration.aspx):
3. 範例:範例內容不見得是完整的,我記得有些甚至沒有範例,看範例的原則在於融會貫通,而不是傻傻的照抄;我剛開始寫.Net 的時候通常看一個範例就會查更多的MSDN文件內容,因為有些範例中可能還會引用一些其它我們從來沒用過的東西(我的經驗裡在Socket和Thread這類的特別多這樣的事情),所以一旦發現範例中有不瞭解的東西出現,務必要以此為關鍵字去了解新朋友的內涵,不要以為「不知為不知」真的能變成「是知也」,學寫程式就是要努力地去知才是正確的,這樣才能有效加速自己的學習。
4. 繼承階層架構:這個是讓我們明瞭此一類別的上下階層關係,就是說明它是繼承哪個類別而來
5. 平台:說明此類別可應用於哪些作業系統。
6. 版本資訊:說明在哪些 .Net Framework中是有支援的。
以下為一個非所有.Net Framwork都支援的畫面
7. 請參閱:請參閱這個連結其實滿重要的,尤其當你在某特定屬性、方法或事件中的「請參閱」多半都會有很多寶可以挖,包含一些How To、範例與概念說明等等,所以千萬別輕易放過這個「請參閱」,因為這個錯綜複雜的連結就是指引你通往寶藏的地標。
8. 抽象類別的提示:有些時候會看到類別說明上有個這樣的字樣 「這是 abstract 類別」,這表示這個是一個只能當成另一個類別的基底類別而不能使用此類別直接產生執行個體。