Jakie narzędzia są dostępne do utworzenia pliku pomocy w Visual Studio 2010?

Question

Potrzebuję napisać plik pomocy dla aplikacji WinForms w Visual Studio 2010. Idealnie, chciałbym użyć narzędzia, które integruje się z Visual Studio, a nie całkowicie oddzielne narzędzie.

W przeszłości korzystałem z pomocy HTML Help Workshop, ale jest to starożytne i pamiętam, że było trochę funky w użyciu. Wiem również, że w zestawie Visual Studio 2005 SDK było narzędzie, ale potrzebuję czegoś na rok 2010.

Answer 1

jest to niewygodne docelową dla producentów narzędzi. W większości sklepów pomoc jest tworzona przez profesjonalnych pisarzy, którzy nie mają żadnego zastosowania w Visual Studio w codziennych działaniach. Narzędzia do tworzenia stron trzecich, takie jak RoboHelp, są preferowaną przez nich bronią.

Narzędzie SDK VS2005 prawdopodobnie zobaczyłeś HelpStudio Lite, produkt Innovasys. Nie ma dostępnej wersji, która integruje się z VS2010 i sądząc po forum post, nie ma zamiaru jej wypuszczać. Ich Dokument X! produkt jednak brzmi jak coś, na co powinieneś rzucić okiem. Wersja eval jest dostępna do pobrania from here.

Answer 2

Prawdopodobnie nie integruje się z VS2010, ale pamiętam, jak korzystałem z RoboHelp w okolicach '97 i było OK: jest więc tak gdybym potrzebował teraz pisać pliki pomocy, prawdopodobnie dałbym to jeszcze raz, ponieważ wygląda na to, że nadal jest w okolicy: here. Wydaje się dość drogi, ale wydaje się, że jeśli masz jakieś licencje Adobe (co nie jest całkowicie nieetyczne dla sklepu deweloperskiego) z jakiegoś innego powodu, może już to masz?

Answer 3

Pamiętam, że jakiś rok temu niektórzy użytkownicy forum Joel poświęconego The Business of Software zalecali HelpNDoc.

Forum dyskusyjne: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10

Answer 4

Oto opcje ...

Jeśli chcesz generator dokumentacji Microsoftu z integracją kontra

• Sandcastle Help File Builder do generowania pliku pomocy
• DocProject w celu zintegrowania go z VS

Chociaż wydaje się, że DocProject doesn't quite support VS2010 yet.

Dla rozwiązania dla MS jest GhostDoc, który robi wsparcie integracji VS 2010 i wydaje się być lepszym rozwiązaniem.

Dla opcji, które nie integrują się z Visual Studio:

• DoxyGen
• Docu
• NDoc3

Answer 5

Jak mówili inni, można konwertować pomocy potrójne ukośnik XML MSDN stylu używając Sandcastle na wszystkich członków klasy szczebla i obiektów

/// <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){ 
... 

Oto link do Sandscastle

więcej bogaty w funkcje generator pomocy, który integruje się z Visual Studio 2010 i generuje wiele formatów pomocy: VSDocMan. Zawiera edytor komentarzy WYSIWYG i faktycznie komentuje dla ciebie część kodu. Niezwykle przydatna

Answer 6

HTML Help, zastępuje HTML Help 2.

http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help2

Answer 7

właśnie robi wiele badań i po przetestowaniu różnych Tools http://www.helpgenerator.com/ to najszybszy sposób, aby połączyć system pomocy.

Answer 8

Doktor ducha z dokumentem lub sandcastle jest drogą do zrobienia ... Reszta jest nadal bardzo prymitywna, jeśli chodzi o rok 2010. Jeśli masz projekt zarówno C#, jak i C++, wtedy documentx będzie sposobem, jeśli jest to tylko C#, a następnie dowolny jeden jest dobry.

Answer 9

Jeśli odbiorcy pliku pomocy jest użytkownik aplikacji pomoc HTML 2 nie jest użyteczna, nadal trzeba utworzyć plik chm. Narzędziem, które może to zrobić dla twojej aplikacji WinForm jest Help Generator for Visual Studio, która zabiera dużo pracy przy przygotowywaniu pomocy i łączeniu jej z formularzami.