C 注釋與XML文件說明

2021-05-05 06:48:49 字數 886 閱讀 9231

c#使用傳統的c風格的注釋方式,即:

除了c風格的注釋外,c#還可以根據特定的注釋自動建立xml格式的文件說明。這些注釋都是單行注釋,但都以3個斜槓 /// 開頭,而不是通常的兩個斜槓。在這些注釋中,可以把包含型別和型別成員的文件說明的xml識別符號放在**中。

編譯器可以識別的識別符號如下:

識別符號 

說明 把行中的文字標記為**,例如:int i=10;

把多行標記為** 

標記為乙個**示例 

說明乙個異常類(編譯器要驗證其語法) 

包含其他文件說明檔案的注釋(編譯器要驗證其語法) 

把列表插入到文件說明中 

標記方法的引數(編譯器要驗證其語法) 

表示乙個單詞是方法的引數(編譯器要驗證其語法) 

說明對成員的訪問(編譯器要驗證其語法) 

給成員新增描述 

說明方法的返回值 

提供對另乙個引數的交叉引用(編譯器要驗證其語法) 

提供描述中的「參見」 部分(編譯器要驗證其語法)

提供型別或成員的簡短小結 

描述屬性 

c#編譯器可以把xml元素從特定的注釋中提取出來,並使用它們生成乙個xml檔案,要讓編譯器為程式集生成xml文件說明,需在編譯時指定/doc選項,其後需跟上要被建立的檔案的名稱:

csc /t:library /doc:mathlib.xml mathlib.cs

如果xml注釋沒有生成格式正確的xml文件,編譯器就丟擲乙個錯誤。

注意:編譯器建立了乙個元素,並為該檔案中的每個類或類成員新增乙個元素。每個元素都有乙個name特性,其中包含成員的全名,前面有乙個字母表示其型別:

「t:」--表示這是乙個型別;

「f:」--表示這是乙個字段;

「m:」--表示這是乙個成員

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

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

php常見文件注釋說明

access 使用範圍 class,function,var,define,module 該標記用於指明關鍵字的訪問許可權 private public或proteced author 指明作者 使用範圍 class,function,var,define,module,use 指明版權資訊 dep...

認識XML文件注釋的標記

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