2012-01-31 99 views
3

我想生成MS Word文件(.doc,.docx)的代碼文檔(C#,.net4)。這不是因爲我認爲它更好,而是因爲與一組HTML文檔相比,版本控制更容易。生成MS Word文件的代碼文檔

我正在研究這種可能性和實用性,並權衡選項。

我看到doxygen可以生成RTF文件。 doxygen沒有問題,我只想知道是否有其他東西(付費或不是),以確保我已經權衡了幾種不同的選擇。

編輯:爲防萬一還不清楚,我想在C#代碼中創建夏季評論的文檔。 Visual Studio已經將它導出到XML。像doxygen這樣的工具會檢查代碼將它們自行存檔。我想將這些評論轉換爲Word文檔。

回答

4

您可以試試我們的VSdocman。它可以生成摘要XML註釋的各種格式,包括RTF。

+0

你知道我看了幾次VSdocman,很遺憾地說我錯過了它輸出RTF文件......謝謝。 – Tony 2012-01-31 21:03:18

+0

僅供參考,截至版本6.2 VSdocman可以直接生成DOCX格式(我是其開發人員之一)。 – 2013-03-21 13:35:06

0

代碼文檔是XML,對吧? This fellow表示您可以通過在「打開」對話框中選擇「使用變換打開」來打開Word中的XML文檔。顯然,提示您提供的信息隨後用於生成XSLT。如果你想堅持它,似乎你可以用它作爲你自己的XSLT的基礎?

關於Visual Studio中的XML註釋的detailed article也建議使用XSLT在網頁上顯示XML。因此,您可以將XML導入到您的Word文檔中

0

SoftArtisan的OfficeWriter可以通過.NET API以編程方式創建.doc和.docx文件。這很不錯,檢查出來。

免責聲明:我是構建最新版本的工程師之一。

0

我想爲MS Word文件(.doc,.docx)生成代碼文檔(C#,.net4)。這不是因爲我認爲它更好,而是因爲與一組HTML文檔相比,版本控制更容易。

您應該以您認爲對軟件用戶最有幫助的任何格式生成文檔。

你的代碼大概是在版本控制。您可以直接從代碼生成帶有API幫助的XML,並且可以使用此XML自身生成幫助文件(無論採用何種格式)。這些輸出文件不一定需要進行版本控制。

+0

對此的推理很尷尬。簡短的版本是我知道HTML文檔使用起來更好。但是,導出不適用於最終用戶。版本控制是客戶設定的過程的一部分... – Tony 2012-01-31 21:00:40

+0

好的,謝謝澄清。不要忘記,如果您只需要爲每個版本添加一次文檔到版本控制,就可以手動將HTML導入Word。 – 2012-02-01 00:08:15