在寫程式的時候,寫註解是一件很煩人的事,但註解不寫,是以後更痛苦的事
在現在的.net的環境下 有很多方式協助寫註解
最基本的就是XML註解(看到XML不要怕,我也不太懂,這是為了方便輸出時候用的)

< summary> ddddddd</summary>
當呼叫有用XML註解的Function Class Structure ..........會顯示在Summary裡 ddddddd 的資訊

< param name="sTitle">123 < /param name>
當要輸入參數 sTitle時 出現的註解123

< returns>567< returns>
傳回值的註解


C# 按 /// 自動出現以下

/// < summary>
///
/// < /summary>
/// < param name="sTitle">
/// < param name="sName">
/// < returns> < /returns><returns></returns><returns></returns>

VB.NET 按 ''' 自動出現以下

''' < summary>
'''
''' < /summary>
''' < remarks>< /remarks>

範例
''' < summary>
''' 傳入檔案路徑 傳回檔案所在磁碟
''' < /summary>
''' < param name="filepath">路徑
''' < returns>磁碟機代號< /returns>
''' < remarks>< /remarks>
Public Function GetFileDisk(ByVal filepath As String)

Dim v As String()
v = Split(filepath, "\")
Return v(0)
End Function

更詳細的說明(中英)
http://www.wewill.cn/n113c7.aspx

更多的XML tag (英)
http://www.winnershtriangle.com/w/articles.xmlcommentsinvbnet.asp
文章標籤
全站熱搜
創作者介紹
創作者 Rh 的頭像
Rh

程式狂想曲

Rh 發表在 痞客邦 留言(0) 人氣(1,093)