生成C＃解決方案的沙堡文檔

Question

我有一個vs2012解決方案，其中包含許多C＃項目。 我想為整個庫使用Sandcastle生成一些文檔。

我一直在審查Sandcastle文檔，但不清楚如何為整個項目生成文檔。

我如何才能在整個解決方案中實現這一目標？

Answer 1

我使用了Sandcastle幫助文件生成器 （而不是直接使用Sandcastle）。

在SHFB項目中，可以在<DocumentationSources>部分中指定多個DLL + XML。

Answer 2

正如ChrisW所指出的，您應該使用Sandcastle幫助文件生成器（SHFB）。 但是，即使使用SHFB提供的干凈簡單的GUI，您也可能需要考慮很多問題才能生成整潔的專業文檔集。 我的文章（“ 馴服Sandcastle：.NET程序員的代碼指南 ”，記錄了我在Simple-Talk.com上遇到的各種潛在陷阱的經驗，可能會節省您一些時間，精力和痛苦：-）。

一旦您消化了文章，並且可能更感興趣了，我就在此單頁的掛圖上提供了有關SHFB和Sandcastle的完整語法和用法指南，可從Simple-Talk.com獲得。 一瞥：