《C#編程入門與應用》—2.7.3　文檔注釋

2.7.3　文檔注釋

C# 提供一種機制，使開發人員可以使用含有XML 文本的特殊注釋語法為他們的代 碼編寫文檔。在源代碼文件中，具有某種格 式的注釋可用于指導某個工具根據這些注釋 和它們后面的源代碼元素生成 XML。使用這 類語法的注釋稱為文檔注釋(Documentation Comment)，有的資料會稱為 XML 注釋。

文檔注釋用于對類或者方法進行描述。 在類或者方法前面連續輸入 3 個“/”，就會 自動生成相應的文檔注釋，用戶需要手動填 寫類或方法的描述信息，來完成文檔注釋的 內容。

所有的文檔注釋都在3個斜線“/”之后， “///”與“//”不同，“//”表示注釋，編譯 器將忽略后面的內容，“///”告訴編譯器后 面是 XML 注釋，需要適當地處理。

【例2-11】

聲明GetUserName() 方法，將一個表示 手機號碼的字符串作為參數傳入該方法中， 最終返回用戶的姓名。聲明后為代碼添加文 檔注釋并完善內容，代碼如下：

上述代碼中，名稱為 summary、param、 returns 的元素名僅僅是VS 能夠識別的一部 分標記，在智能感知功能中，并沒有把C# 規范中的所有標記列出來，遺失的部分只能 手工插入。這些手工標記是非常有用的，如 果恰當地設置，對導出成外部說明文件是非 常有幫助的。

文檔注釋的使用非常簡單，常用標簽只 有上述幾個。這是因為大部分項目中的注釋 僅僅是給開發人員自己看的，如果想要生成 類似 MSDN 這樣的文檔，需要了解更多的標簽。常見標簽及標簽說明如表 2-3 所示。

表 2-3　文檔注釋常見的幾個標簽

C#

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。