認識XML文件注釋的標記

2021-09-25 20:14:58 字數 378 閱讀 6173

在編寫**時,為型別以及型別的成員新增文件注釋是乙個好的習慣。c#以及其他.net語言的編譯器能夠將文件注釋處理成乙個xml檔案,再利用一些工具(如sandcastle和已經死去的ndoc),還能把文件注釋製作成幫助文件。所以,有必要學習一下文件注釋推薦使用的標記。

理論上,可以使用任意的標記,不過在msdn中,推薦使用以下的文件注釋標記:

有些標記比較簡單,可能已經被大家所熟悉和使用了,比如。而且如果使用了開發工具的話(如visual studio),還能自動生成標記以及屬性,非常方便。

除了這些標記之外,其他語言,如vb.net,和一些文件生成工具,如ndoc和sandcastle等,還補充了一些標記:

這些補充的標記能夠幫助文件生成工具在生成文件的時候,提供更豐富的內容。

認識XML文件注釋的標記

在編寫 時,為型別以及型別的成員新增文件注釋是乙個好的習慣。c 以及其他.net語言的編譯器能夠將文件注釋處理成乙個xml檔案,再利用一些工具 如sandcastle和已經死去的ndoc 還能把文件注釋製作成幫助文件。所以,有必要學習一下文件注釋推薦使用的標記。理論上,可以使用任意的標記,不過在ms...

XML文件標記

xml文件中有六種標記 1 elements 最常見的標記形式,它確定它們所包圍的內容。以start tag開始,以end tag結束非空元素包含了子元素或字元資料。空元素沒有內容,能寫成以下二種形式 or 2 attributes 是出現在元素的first tag中位於元素名稱後的名稱 值對。所有...

XML 文件注釋(C 程式設計指南)

在 visual c 中,可以為 建立文件,方法是在 xml 標記所指的 塊前面,直接在源 的特殊注釋欄位中包括 xml 標記。例如 this class performs an important function.public class myclass 使用 doc 進行編譯時,編譯器將在源 ...