本篇經(jīng)驗(yàn)將和大家介紹如何使用Sandcastle Help File Builder生成C#類文檔，希望對大家的工作和學(xué)習(xí)有所幫助！ 安裝Sandcastle Help File Builder

本篇經(jīng)驗(yàn)將和大家介紹如何使用Sandcastle Help File Builder生成C#類文檔，希望對大家的工作和學(xué)習(xí)有所幫助！

安裝Sandcastle Help File Builder

首先，在開始菜單中找到Sandcastle Help File Builder下的“Sandcastle Help File Builder GUI”選項(xiàng)，如下圖所示：

然后，點(diǎn)擊“File”-gt;“New Project”選項(xiàng)，如下圖所示：

接著，在磁盤中的某個位置創(chuàng)建并保存一個解決方案，如下圖所示：

添加文檔源

在打開的解決方案中，右鍵點(diǎn)擊“Documentation Source”，選擇“Add Documentation Source”選項(xiàng)，并添加需要引用的dll（該目錄下同時(shí)需要有個對應(yīng)的xml文件），如下圖所示：

接著，右鍵點(diǎn)擊“Reference”，選擇“Add File/Project Reference”選項(xiàng)，如下圖所示：

配置生成選項(xiàng)

在Build這個Tab頁中，如果需要生成web網(wǎng)頁，需要勾選“WebSite（）”選項(xiàng)，如下圖所示：

然后，在Help File這個Tab頁中，可以設(shè)置標(biāo)題和語言顯示等選項(xiàng)，如下圖所示：

生成文檔

完成以上配置后，點(diǎn)擊工具欄中的“生成”按鈕，開始生成文檔，如下圖所示：

生成完畢后，可以在日志中查看詳細(xì)信息，如下圖所示：

查看文檔

生成的文檔會保存在指定目錄下，可以找到對應(yīng)的html文件，并使用瀏覽器打開，即可查看C#的網(wǎng)頁文檔，如下圖所示：

通過上述步驟，我們可以使用Sandcastle Help File Builder輕松地生成C#類文檔，方便我們在工作和學(xué)習(xí)中進(jìn)行參考和查閱。