NDoc

　編寫代碼文檔資料幾乎總是一項令人畏懼的任務。我所說的不是早期設計文檔，甚至也不是更為詳細的設計文檔；我說的是記錄類上的各個方法和屬性。NDoc 工具能夠使用反射來分析程序集，并使用從 C# XML 注釋生成的 XML 自動為代碼生成文檔資料。XML 注釋僅適用于 C#，但有一個名為 VBCommenter 的 Visual Studio .NET Power Toy，它能夠為 Visual Basic .NET 完成類似的工作。此外，下一版本的 Visual Studio 將為更多語言支持 XML 注釋。

　使用 NDoc 時，您仍然在編寫代碼的技術文檔，但您是在編寫代碼的過程中完成了文檔編寫工作（在 XML 注釋中），而這更容易忍受。使用 NDoc 時，第一步是為您的程序集打開 XML 注釋生成功能。右鍵單擊該項目并選擇 Properties | Configuration Properties | Build，然后在 XML Documentation File 選項中輸入用于保存 XML 文件的路徑。當該項目生成時，將創建一個 XML 文件，其中包含所有 XML 注釋。下面是 NUnit 示例中的一個用 XML 編寫了文檔的方法：

/// <summary> /// This test adds a number of values to the Hashtable collection /// and then retrieves those values and checks if they match. /// </summary> [Test] public void HashtableAddTest() { //Method Body Here }?

?有關該方法的 XML 文檔資料將被提取并保存在 XML 文件中，如下所示：

<member name="M:NUnitExample.HashtableTest.HashtableAddTest"> <summary>This test adds a number of values to the Hashtable collection and then retrieves those values and checks if they match.</summary> </member>?

?

　NDoc 使用反射來考察您的程序集，然后讀取該文檔中的 XML，并且將它們進行匹配。NDoc 使用該數據來創建任意數量的不同文檔格式，包括 HTML 幫助文件 (CHM)。在生成 XML 文件以后，下一步是將程序集和 XML 文件加載到 NDoc 中，以便可以對它們進行處理。通過打開 NDoc 并單擊 Add 按鈕，可以容易地完成該工作。

　在將程序集和 XML 文件加載到 NDoc 中并且使用可用的屬性范圍自定義輸出以后，單擊 Generate 按鈕將啟動生成文檔資料的過程。使用默認的屬性，NDoc 可以生成一些非常吸引人并且實用的 .html 和 .chm 文件，從而以快速有效的方式自動完成原來非常乏味的任務。

　NDoc 是一個開放源代碼項目，并且可以從 http://ndoc.sourceforge.net 下載。

NAnt

　NAnt 是一個基于 .NET 的生成工具，與當前版本的 Visual Studio .NET 不同，它使得為您的項目創建生成過程變得非常容易。當您擁有大量從事單個項目的開發人員時，您不能依賴于從單個用戶的座位進行生成。您也不希望必須定期手動生成該項目。您更愿意創建每天晚上運行的自動生成過程。NAnt 使您可以生成解決方案、復制文件、運行 NUnit 測試、發送電子郵件，等等。遺憾的是，NAnt 缺少漂亮的圖形界面，但它的確具有可以指定應該在生成過程中完成哪些任務的控制臺應用程序和 XML 文件。注意，MSBuild（屬于 Visual Studio 2005 的新的生成平臺）為每種健壯的生成方案進行了準備，并且由基于 XML 的項目文件以類似的方式驅動。

實際運行的 NAnt

　在該示例中，我將為前面創建的 NUnitExample 解決方案創建一個 NAnt 版本文件。首先，我需要創建一個具有 .build 擴展名的 XML 文件，將其放在我的項目的根目錄中，然后向該文件的頂部添加一個 XML 聲明。我需要添加到該文件的第一個標記是 project 標記：

<?xml version="1.0"?> <project name="NUnit Example" default="build" basedir="."> <description>The NUnit Example Project</description> </project>

?　項目標記還用于設置項目名稱、默認目標以及基目錄。Description 標記用于設置該項目的簡短說明。

　接下來，我將添加 property 標記，該標記可用于將設置存儲到單個位置（隨后可以從文件中的任意位置訪問該位置）。在該例中，我將創建一個名為 debug 的屬性，我可以隨后將其設置為 true 或 false，以反映我是否要在調試配置下編譯該項目。（最后，這一特定屬性并未真正影響如何生成該項目；它只是您設置的一個變量，當您真正確定了如何生成該項目時將讀取該變量。）

　接下來，我需要創建一個 target 標記。一個項目可以包含多個可在 NAnt 運行時指定的 target。如果未指定 target，則使用默認 target（我在 project 元素中設置的 target）。在該示例中，默認 target 是 build。讓我們觀察一下 target 元素，它將包含大多數生成信息：

<target name="build" description="compiles the source code"> </target>

?　在 target 元素內，我將把 target 的名稱設置為 build，并且創建有關該 target 將做哪些工作的說明。我還將創建一個 csc 元素，該元素用于指定應該傳遞給 csc C# 編譯器的數據。讓我們看一下該 csc 元素：

<csc target="library" output="./bin/debug/NUnitExample.dll" debug="${debug}"> <references> <includes name="C:/program files/NUnit V2.1/bin/NUnit.Framework.dll"/> </references> <sources> <includes name="HashtableTest.cs"/> </sources> </csc>?

?　首先，我必須設置該 csc 元素的 target。在該例中，我將創建一個 .dll 文件，因此我將 target 設置為 library。接下來，我必須設置 csc 元素的 output，它是將要創建 .dll 文件的位置。最后，我需要設置 debug 屬性，它確定了是否在調試中編譯該項目。因為我在前面創建了一個用于存儲該值的屬性，所以我可以使用下面的字符串來訪問該屬性的值：${debug}。Csc 元素還包含一些子元素。我需要創建兩個元素：references 元素將告訴 NAnt 需要為該項目引用哪些程序集，sources 元素告訴 NAnt 要在生成過程中包含哪些文件。在該示例中，我引用了 NUnit.Framework.dll 程序集并包含了 HashtableTest.cs 文件。以下代碼中顯示了完整的生成文件。（您通常還要創建一個干凈的 target，用于刪除生成的文件，但為了簡潔起見，我已經將其省略。）

<?xml version="1.0"?> <project name="NUnit Example" default="build" basedir="."> <description>The NUnit Example Project</description> <property name="debug" value="true"/> <target name="build" description="compiles the source code"> <csc target="library" output="./bin/debug/NUnitExample.dll" debug="${debug}"> <references> <includes name="C:/program files/NUnit V2.1/bin/NUnit.Framework.dll" /> </references> <sources> <includes name="HashtableTest.cs"/> </sources> </csc> </target> </project>

　要生成該文件，我需要轉到我的項目的根目錄（生成文件位于此處），然后從該位置執行 nant.exe。如果生成成功，您可以在該應用程序的 bin 目錄中找到 .dll 和 .pdb 文件。盡管使用 NAnt 肯定不像在 Visual Studio 中單擊 Build 那樣簡單，但它仍然是一種非常強大的工具，可用于開發按自動計劃運行的生成過程。NAnt 還包括一些有用的功能，例如能夠運行單元測試或者復制附加文件（這些功能沒有受到當前 Visual Studio 生成過程的支持）。

　NAnt 是一個開放源代碼項目，并且可以從 http://nant.sourceforge.net 下載。

轉換工具

　我已經將兩個獨立的工具合在一起放在標題“轉換工具”下面。這兩個工具都非常簡單，但又可能極為有用。第一個工具是 ASP.NET 版本轉換器，它可用于轉換 ASP.NET（虛擬目錄在它下面運行）的版本。第二個工具是 Visual Studio Converter，它可用于將項目文件從 Visual Studio .NET 2002 轉換到 Visual Studio .NET 2003。

　當 IIS 處理請求時，它會查看正在請求的文件的擴展名，然后基于該 Web 站點或虛擬目錄的擴展名映射，將請求委派給 ISAPI 擴展或者自己處理該請求。這正是 ASP.NET 的工作方式；將為所有 ASP.NET 擴展名注冊擴展名映射，并將這些擴展名映射導向 aspnet_isapi.dll。這種工作方式是完美無缺的，除非您安裝了 ASP.NET 1.1 — 它會將擴展名映射升級到新版本的 aspnet_isapi.dll。當在 ASP.NET 1.0 上生成的應用程序試圖用 1.1 版運行時，這會導致錯誤。要解決該問題，可以將所有擴展名映射重新轉換到 1.0 版的 aspnet_isapi.dll，但是由于有 18 種擴展名映射，所以手動完成這一工作將很枯燥。這正是 ASP.NET 版本轉換器可以發揮作用的時候。使用這一小型實用工具，可以轉換任何單個 ASP.NET 應用程序所使用的 .NET 框架的版本。

圖 9 ASP.NET 版本轉換器

　圖 9 顯示了實際運行的 ASP.NET 版本轉換器。它的使用方法非常簡單，只須選擇相應的應用程序，然后選擇您希望該應用程序使用的 .NET 框架版本。該工具隨后將使用 aspnet_regiis.exe 命令行工具將該應用程序轉換到所選版本的框架。隨著將來版本的 ASP.NET 和 .NET 框架的發布，該工具將變得更為有用。

　ASP.NET 版本轉換器由 Denis Bauer 編寫，并且可以從 http://www.denisbauer.com/NETTools/ASPNETVersionSwitcher.aspx 下載。

　Visual Studio .NET 項目轉換器（參見圖 10）非常類似于 ASP.NET 版本轉換器，區別在于它用于轉換 Visual Studio 項目文件的版本。盡管在 .NET 框架的 1.0 版和 1.1 版之間只有很小的差異，但一旦將項目文件從 Visual Studio .NET 2002 轉換到 Visual Studio .NET 2003，將無法再把它轉換回去。雖然這在大多數時候可能不會成為問題（因為在 .NET 框架 1.0 版和 1.1 版之間幾乎沒有什么破壞性的更改），但在某些時刻您可能需要將項目轉換回去。該轉換器可以將任何解決方案或項目文件從 Visual Studio 7.1 (Visual Studio .NET 2003) 轉換到 Visual Studio 7.0 (Visual Studio .NET 2002)，并在必要時進行反向轉換。

圖 10 Visual Studio .NET 項目轉換器

Visual Studio .NET 項目轉換器由 Dacris Software 編寫。該工具可以從 http://www.codeproject.com/macro/vsconvert.asp 下載。?

From： http://www.godist.cn/blog/article.asp?id=397

總結

以上是生活随笔為你收集整理的.Net开发人员应该下载的十种必备工具(三)的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。