2013-10-29 78 views
11

我已經繼承了一堆C#代碼。對於幾個方法定義,我發現///<exclude/>是它前面的唯一XMLDoc。我試圖谷歌的意思,但沒有成功。有人可以解釋這可能意味着什麼嗎?「/// <exclude/>」是什麼意思?

回答

14

至少在NDoc這意味着該成員的XML文檔應該被排除。來自documentation

<exclude/>標記指示NDoc從文檔中排除當前項目。

我不清楚這是否最初是NDoc特定的,但它似乎也支持Sandcastle(因爲它在Sandcastle XML comments guide)。

+0

@Hanky웃Panky:要回答這個問題:這是喬恩斯基特(​​期)! ;-) – Andreas

+0

我沒有證據表明這個項目使用NDoc。也許過去有人試圖開始使用NDoc。如果沒有其他已知的用法,我拿Jon的答案。謝謝! – Andreas

2

Sandcastle Help File Builderdocumentation

命名空間通過命名空間摘要屬性排除或 項目被排除在外,因爲它的XML註釋包括<排除/ > 標籤。此信息與API過濾器 設置自動合併。要更改這些項目,您需要使用名稱空間 Summaries屬性或從項目的XML註釋中移除標籤。

正式答覆:

A way to exclude documentation?

而且更多信息有關的行爲:

Problems with missing members and tag

+1

感謝您的回答。 – Andreas