C#文檔自動(dòng)化了解之前我們先來(lái)了解什么是C#文檔自動(dòng)化，熟悉java的程序員都知道，在java中有一種“文檔注釋”。采用這種注釋之后，使用相應(yīng)的命令，我們就可以得到與代碼相關(guān)的文檔說(shuō)明。如今，在.net的世界中C#也提供了相同的功能。如果結(jié)合相應(yīng)的工具，它還可以為我們產(chǎn)生漂亮的WEB風(fēng)格的文檔。

C#文檔自動(dòng)化初步認(rèn)識(shí)：

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

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

C#文檔自動(dòng)化的特點(diǎn)：

但是，并不是所有使用文檔注釋和這些標(biāo)記的地方編譯器都會(huì)為我們生成文檔，它還會(huì)看這些標(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#文檔自動(dòng)化之產(chǎn)生文檔的命令

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

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

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

C#文檔自動(dòng)化的初步認(rèn)識(shí)就向你介紹到這里，希望對(duì)你了解和學(xué)習(xí)C#文檔自動(dòng)化有所幫助。

【編輯推薦】

1. C#代碼格式化實(shí)際應(yīng)用解析
2. C#調(diào)用瀏覽器的功能實(shí)現(xiàn)淺析
3. C#調(diào)用瀏覽器的原理及實(shí)現(xiàn)淺析
4. C#文件瀏覽器制作的詳細(xì)過(guò)程
5. C#貨幣格式轉(zhuǎn)化實(shí)例解析