2009-07-06 56 views
2

我正在尋找一個體面的C#代碼文檔生成器,可以直接從源代碼創建html格式的文檔。來自源代碼的C#文檔?

我不想使用沙堡,因爲它太繁瑣了,我不使用VS來做我的工作,儘管Sandcastle的輸出正是我所需要的。

我還需要Doxygen的功能 - 只需保存一個文件,按一個按鈕,然後出現文檔。問題是Doxygen不會產生類似MSDN的輸出。

定製的風格將是一個加號,以及用於很多其他的樣式,比如原型,花,VS2005等支持

回答

0

您沒有指定是否需要開源代碼,所以我會建議一個商業軟件包Doc-o-matic(來自toolsfactory.com)。它高度可配置,並處理源代碼中的註釋(xdoc或javadoc樣式)。它將生成.chm,.html,.pdf和Help2格式(將與Visual Studio集成)。我認爲有免費試用。用戶界面有點笨拙,整理所有設置需要一段時間,但總的來說,它工作得很好。我用它來記錄.NET API(使用C++)和COM API(使用VB)。

12

由於沙堡的輸出爲「你想要什麼」,我可能會問,如果你熟悉Sandcastle Help File Builder?這是一個GUI,可以將大部分煩人的事情自動化。

+0

好吧,Sandcastle從程序集生成文檔,我需要它直接從我的.cs源文件生成(我正在構建一個框架)。 – Aethex 2009-07-06 17:51:51

0

我可以虛心地建議嘗試ImmDoc.NET - 我前段時間開發的一個簡單項目,最近發佈在CodePlex上。它重量輕,使用非常簡單,並支持.NET 2.0。它也可以創建CHM輸出。

1

我們已經使用了DocumentX和HelpStudio從InnovaSys好幾年來爲我們的.NET組件生成文檔。按照InnovaSys網站,DocumentX用於通過多項領先組件供應商:

領先的組件供應商,包括Infragistics的,劍鋒,數據動態,登打士,的SpreadsheetGear和Telerik的生產他們的商業技術文檔中使用

我最喜歡的DocumentX功能是相當全面的WYSIWYG編輯器,它可以在Visual Studio中正常工作。我唯一的抱怨是,建築幫助有點慢 - 但這些好處肯定彌補了這一點。

我對InnovaSys沒有興趣,除了我是他們產品的快樂用戶。