DocProject vs Sandcastle幫助文件生成器GUI

我有幾個C＃項目以及一些內部庫組件，我試圖一起記錄。 Sandcastle似乎是從C＃生成文檔的地方。我想知道DocProject或Sandcastle幫助文件生成器GUI中的哪一個更好，並且支持我需要的功能。DocProject vs Sandcastle幫助文件生成器GUI

我想只編譯每個項目擁有文檔的一部分，然後把它全部集成在一起到底。（即一個文檔項目中的庫組件和每個項目都在它自己的文檔項目中，然後使用Help 2查看器在單個根中執行上述所有操作）

來源

2008-11-26 Nathan

我可以爲Sandcastle幫助文件生成器進行擔保。它工作得很好，您可以在Sandcastle Help File Builder項目中記錄任意數量的程序集。從理論上講，您可以擁有一個Builder項目併爲每個C＃項目生成一個文檔，然後擁有一個記錄所有內容的主生成器項目。

來源

2008-12-03 01:42:11

這裏是沙堡基於.NET文檔一些有用的鏈接：

Tutorial on Sandcastle

Sandcastle Help File Builder（SHFB）
Tutorial on SHFB

Web Project Documentation
Tutorial on how to document Web Projects（更多手動和我相信過時給出先前的鏈接）

MSDN reference for XML Documentation

來源

2008-12-29 16:35:27

Sandcastle非常慢，並且需要安裝和手動引用諸如Microsoft.Scripting.dll v1.1.0.20等依賴項。如果您已經將文檔以XML格式編寫，並且您希望編譯文檔的庫，那麼它的效果也最好。在使用現代四核系統的中等規模的圖書館中，期望等待1小時或更長時間才能構建文檔。 – 2015-03-14 18:32:27

文檔項目產生更精緻的文檔 - 當它工作 - 這是不是所有的時間。這是一個更加風格化的產品。

沙堡幫助文件生成器是固體和能夠完成任務。

來源

2009-05-19 15:01:20 Tekdream

沙堡是廢話。 – 2015-03-12 06:45:12

我沒有用DocProject但似乎與能力堪比沙堡的產物。

我用Sandcastle，我發現這是一個有效的工具。您還需要Sandcastle Help File Builder（SHFB）爲您提供一個良好的前端，正如其他人在此提到的那樣。此外，您需要Sandcastle Styles用於Sandcastle引擎的表示層補丁。儘管所有這三個組件在2010年中期都有新版本，但由於Firefox 3.6中存在渲染缺陷（2010.09.06條目中記錄了此defect report），我推遲了2008版本的升級。

我已經徹底證明我的描述這個問題和各種其他的，你可能需要或希望以產生一個整潔，專業的文檔集要考慮平臺的經驗。我的文章「Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code」剛於2010年9月在Simple-Talk.com上發佈;它可能會節省你一些時間，精力和痛苦:-)。

來源

2010-09-14 23:06:03

DocProject是Sandcastle的ADDON。它不是一個獨立的應用程序>> https://docproject.codeplex.com/ – 2015-03-12 06:46:57

DocProject vs Sandcastle幫助文件生成器GUI

回答

相關問題