?產生chm文檔工具- Sandcastle -摘自網路

來源:互聯網
上載者:User

標籤:

Sandcastle是微軟官方的文檔產生工具,NDoc開發停止後,這個貌似也是唯一的一個這方面的工具。它從dll檔案及其xml注釋檔案能夠 產生完整的協助文檔,支援多種產生格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),結合新發布的Sandcastle Help File Builder視覺化檢視,整個產生過程十分簡單,而且SHFB工具看起來很強大,不僅能夠直接配置產生文檔的各個屬性,而且還支援很靈活的擴充設定,為 我們提供完美的.NET類庫文檔成為一個可能。

http://sandcastle.codeplex.com/documentation

產生chm文檔工具介紹

Sandcastle是微軟官方的文檔產生工具,NDoc開發停止後,這個貌似也是唯一的一個這方面的工具。它從dll檔案及其xml注釋檔案能夠 產生完整的協助文檔,支援多種產生格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),結合新發布的Sandcastle Help File Builder視覺化檢視,整個產生過程十分簡單,而且SHFB工具看起來很強大,不僅能夠直接配置產生文檔的各個屬性,而且還支援很靈活的擴充設定,為 我們提供完美的.NET類庫文檔成為一個可能。

從這裡下載工具:

Sandcastle:http://sandcastle.codeplex.com/,點擊右側的download大家都懂的。

Sandcastle Help File Builder:http://shfb.codeplex.com/

在SHFB的壓縮包裡我發現了一個VS外掛程式,因此接下來我就打算用VS來示範,如果不想裝這個外掛程式的話,可以運行C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleBuilderGUI.exe這個程式,結果都是一樣的

產生chm文檔

重頭戲來了,開啟VS,建立項目:

點確定,右側項目結構:

選擇ContentLayout.content,看左邊,這裡有一些文件屬性以及版本號碼等資訊,但是我們這裡用不到,因此刪掉。如果留著也沒事,就是在產生文檔的時候頭部多了幾行而已,有興趣的朋友可以繼續研究。

選擇要產生文檔的程式集(對應的XML會自動添加),

 

右擊項目選擇屬性:

到這裡為止可謂是萬事俱備,只欠東風。那麼,東風在哪裡呢?很簡單,產生項目。如果在產生的過程中沒有錯誤的話,那麼在項目目錄的Help檔案夾下你就會看到:

開啟測試文檔:

?產生chm文檔工具- Sandcastle -摘自網路

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.