類別加上說明 in Visual Studio 2005
寫程式的時候
常常會寫類別,再把自己寫好的類別編譯;
但是編譯後就看不到原始碼,
使用的人很難從類別名稱知道這個類別怎樣使用,
所以VS2005有這個貼心的小功能。
只要在自己寫好的類別上面加上一些TAG,
當有人include這些類別時,就會看到這類別的說明了。
在C#下,類別的上面打上///
在VB下,類別的上面打上'''
VS就會自己出現一些TAG給你選,讓你去說明這個類別了。
<summary></summary>:類別的主要說明
<remarks></remarks>:輔助說明
<param></param>:傳入的參數說明
<returns></returns>:回傳值的說明
<value></value>:屬性的說明
常常會寫類別,再把自己寫好的類別編譯;
但是編譯後就看不到原始碼,
使用的人很難從類別名稱知道這個類別怎樣使用,
所以VS2005有這個貼心的小功能。
只要在自己寫好的類別上面加上一些TAG,
當有人include這些類別時,就會看到這類別的說明了。
在C#下,類別的上面打上///
在VB下,類別的上面打上'''
VS就會自己出現一些TAG給你選,讓你去說明這個類別了。
<summary></summary>:類別的主要說明
<remarks></remarks>:輔助說明
<param></param>:傳入的參數說明
<returns></returns>:回傳值的說明
<value></value>:屬性的說明