C#中怎么實現(xiàn)自動化文檔

發(fā)布時間：2021-08-06 15:30:57 來源：億速云閱讀：120 作者：Leah 欄目：編程語言

這篇文章將為大家詳細(xì)講解有關(guān)C#中怎么實現(xiàn)自動化文檔，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關(guān)知識有一定的了解。

C#文檔自動化初步認(rèn)識：

在C#中文檔注釋對應(yīng)的符號是：///。但光使用它還是不能為我們產(chǎn)生代碼文檔，還必須使用特殊的標(biāo)記才行。這些標(biāo)記實際上是XML標(biāo)記，最常用的是< summary >。例如：

/// <summary>   /// A method with a string array param.   /// </summary>   public void Koo(string[] ss) {}

C#文檔自動化的特點：

但是，并不是所有使用文檔注釋和這些標(biāo)記的地方編譯器都會為我們生成文檔，它還會看這些標(biāo)記是否與一些代碼結(jié)構(gòu)相關(guān)聯(lián)。例如：

/// <summary>   /// 不產(chǎn)生這行   /// </summary>

就不產(chǎn)生任何文檔。這些代碼結(jié)構(gòu)必須是：class, struct, enum, method, property, field, indexer, delegate, 或event.

C#文檔自動化之產(chǎn)生文檔的命令

◆命令行：csc /doc: ….xml …..cs；

◆如使用VS.net，則：項目 -> 屬性 -> 配置屬性 -> 生成 -> 輸出 -> xml文檔文件(在此填寫文件名和路徑)；

◆如要生成web注釋：工具 ->生成注釋 web......。

關(guān)于C#中怎么實現(xiàn)自動化文檔就分享到這里了，希望以上內(nèi)容可以對大家有一定的幫助，可以學(xué)到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。

向AI問一下細(xì)節(jié)

猜你喜歡