国产探花免费观看_亚洲丰满少妇自慰呻吟_97日韩有码在线_资源在线日韩欧美_一区二区精品毛片,辰东完美世界有声小说,欢乐颂第一季,yy玄幻小说排行榜完本

首頁 > 編程 > .NET > 正文

十個必備的.NET開發(fā)小工具(7):NDoc

2024-07-10 13:05:08
字體:
供稿:網(wǎng)友
ndoc



編寫代碼文檔一直是一項令人生畏的任務(wù)。這里我并不是指設(shè)計初期的文檔或更為詳細(xì)的設(shè)計文檔,而是指類中方法和屬性的文檔。ndoc工具能使用反射檢查程序集并使用從c# xml注釋生成的xml文檔自動為你的代碼生成文檔。目前只有c#提供xml注釋,但利用visual studio .net小工具vb commenter 可以使visual basic .net具有xml注釋功能。另外,visual studio的下一個發(fā)布版本將對更多的語言支持xml注釋。



利用ndoc,你很容易在編寫代碼的同時形成文檔(在xml注釋中)。要使用ndoc,首先要在visual studio.net中打開程序集的xml注釋生成功能。右鍵點擊項目,選擇properties | configuration properties | build ,然后在“xml documentation file”項中輸入保存xml文件的路徑。當(dāng)項目編譯時,就會創(chuàng)建一個包括所有xml注釋的xml文件。下面是nunit范例中一個方法的xml文檔:

///
/// this test adds a number of values to the hashtable collection
/// and then retrieves those values and checks if they match.
///
[test]
public void hashtableaddtest()
{
//method body here
}

該方法的xml文檔將被抽取并保存到xml文件中,如下所示:


this test adds a number of values to the hashtable collection
and then retrieves those values and checks if they match.


ndoc利用反射查看程序集,然后讀取文檔中的xml并進行匹配。ndoc可使用該數(shù)據(jù)創(chuàng)建各種不同的文檔格式,包括msdn風(fēng)格的html幫助文件格式(.chm)、visual studio .net 幫助文件格式(html help 2)等。生成xml文件之后,下一步是將程序集和xml文件加載到ndoc中以便進行處理。操作很簡單,只需打開ndoc并點擊“add”按鈕,然后添加相關(guān)文件即可。



一旦程序集和xml文件載入ndoc中并根據(jù)屬性范圍定制輸出后,點擊“generate”按鈕就開始生成文檔。使用默認(rèn)屬性,ndoc會生成一些非常有用的.html和.chm文件,因而以快速和有效的方式自動完成了煩人的任務(wù)。

  • 本文來源于網(wǎng)頁設(shè)計愛好者web開發(fā)社區(qū)http://www.html.org.cn收集整理,歡迎訪問。
  • 發(fā)表評論 共有條評論
    用戶名: 密碼:
    驗證碼: 匿名發(fā)表
    主站蜘蛛池模板: 繁昌县| 嘉峪关市| 白银市| 新田县| 介休市| 马龙县| 长顺县| 玛曲县| 青神县| 石景山区| 泽普县| 南投县| 尤溪县| 淮阳县| 山阳县| 汪清县| 论坛| 邯郸市| 晴隆县| 新民市| 额济纳旗| 巴里| 柳河县| 睢宁县| 崇文区| 通化县| 阜平县| 中山市| 平远县| 富蕴县| 镇远县| 东乌珠穆沁旗| 丽水市| 习水县| 巧家县| 满城县| 湾仔区| 荔波县| 宁强县| 庆阳市| 讷河市|