2010-06-19 100 views
18

我需要在Visual Studio 2010中爲WinForms應用程序編寫幫助文件。理想情況下,我想使用與Visual Studio集成的工具,而不是完全獨立的工具。什麼工具可用於在Visual Studio 2010中創建幫助文件?

在過去,我使用過HTML Help Workshop,但這是古老的,我記得使用它有點時髦。我也知道Visual Studio 2005 SDK中內置了一個工具,但我需要2010年的一些東西。

+0

你認爲「集成」是什麼?上下文相關幫助彈出窗口? – 2010-06-21 09:17:36

+0

@Macro - 我正在尋找一種工具,可以讓我使用Visual Studio編寫和編譯幫助文件。 – 2010-06-21 11:27:56

+0

幫助文件中將包含哪些主題或內容:最終用戶/ UI主題?還是軟件/ API主題? – ChrisW 2010-06-23 11:42:38

回答

8

它是工具供應商的尷尬目標。在大多數商店中,這些幫助由專業作家撰寫,這些作者在日常活動中對Visual Studio沒有任何用處。像RoboHelp這樣的第三方製作工具是他們首選的武器。

您可能看到的VS2005 SDK工具是Innovasys的產品HelpStudio Lite。沒有與VS2010集成的版本,並且從forum post判斷他們無意釋放一個版本。他們的文件X!產品,但聽起來像你應該看看。評估版可以下載from here

+1

Adob​​e FrameMaker 12內置了用於生成CHM的工具,所以通常它可以將XML文件(可以在VS中生成)轉換爲CHM。 – user2868288 2015-06-17 19:39:01

0

可能不會與VS2010集成,但我記得在'97周圍使用RoboHelp並且它沒問題:那麼ish如果我現在需要寫幫助文件,我可能會再看一次,因爲它似乎仍然在here左右。雖然看起來相當昂貴,但如果你有一些Adobe許可證(這對開發商店來說不完全不合適),也許你已經有了這個?

13

這裏是你的選擇...

如果你想微軟與VS集成文檔生成:

雖然,看起來是DocProject doesn't quite support VS2010 yet

對於非MS解決方案有GhostDoc,這確實支持VS 2010的整合,似乎是一個更好的解決方案。

對於那些沒有集成到Visual Studio中的選項:

+4

Sandcastle可能適用於記錄API,但不適用於記錄應用程序GUI;你不同意嗎? – ChrisW 2010-06-23 09:26:04

+0

@ChrisW由於WinForms/WPF應用程序通常不會在自動生成的Designer/XAML文件中包含註釋,所以沒有應用程序可以從源代碼直接提取的註釋中生成文檔。我認爲,由於該問題適用於自動生成文檔,因此OP期望創建一個「軟件用戶手冊」而不是一般的「用戶手冊」。 – 2010-06-23 10:07:52

+0

@ChrisW不錯的封閉式暗示性問題。 – 2010-06-23 10:08:46

1

正如其他人所說,你可以在所有類級別的會員使用沙堡轉換三斜槓XML MSDN形式的幫助和對象

/// <summary> 
/// I am a method help Header 
/// </summary> 
/// <param name="parm1">info for param 1</param> 
/// <param name="parm2">info for parm2</param> 
/// <remarks>Some Extra Info</remarks> 
public override void MeMethod(SourceElement rootElm, Subject subject){ 
... 

這裏是鏈接到Sandscastle

一個更多功能豐富幫助生成器與Visual Studio 2010集成並生成多種幫助格式爲VSDocMan。它包括一個所見即所得的評論編輯器,並且實際上爲你評論一些你的代碼。非常有用

1

ghost doc with documentx or sandcastle is to go ... 2010年,休息仍然是非常原始的。如果你有C#和C++兩個項目,那麼documentx將會是它的正義C#一個是好的。

1

如果您的幫助文件的受衆是應用程序的用戶,那麼html幫助2將無法使用,您仍然需要創建一個chm文件。從你的winforms應用程序中可以做到這一點的工具是Help Generator for Visual Studio,它在準備幫助並將其與表單鏈接時需要很多工作。

相關問題