Какие инструменты доступны для создания файла справки в Visual Studio 2010? - PullRequest
Новая
       34

Какие инструменты доступны для создания файла справки в Visual Studio 2010?

18 голосов
/ 20 июня 2010

Мне нужно написать файл справки для приложения WinForms в Visual Studio 2010. В идеале я хотел бы использовать инструмент, который интегрируется с Visual Studio, а не совершенно отдельный инструмент.

Раньше я пользовался HTML Help Workshop, но это уже давно, и я помню, что это было немного забавно в использовании. Я также знаю, что в SDK для Visual Studio 2005 был встроен инструмент, но мне нужно кое-что для 2010 года.

Ответы [ 9 ]

13 голосов
/ 23 июня 2010

Вот ваши варианты ...

Если вам нужен генератор документации Microsoft с интеграцией VS:

Хотя, похоже, что DocProject еще не совсем поддерживает VS2010 .

Для решения не от MS есть GhostDoc , который поддерживает поддержку интеграции с VS 2010 и представляется лучшим решением.

Для параметров, которые не интегрируются в Visual Studio:

7 голосов
/ 26 июня 2010

это неловкая цель для поставщиков инструментов. В большинстве магазинов справка написана профессиональными авторами, которые не используют Visual Studio в своей повседневной деятельности. Сторонние инструменты авторинга, такие как RoboHelp, являются их предпочтительным оружием.

Инструмент VS2005 SDK, который вы, вероятно, видели, был HelpStudio Lite , продукт Innovasys. Нет доступной версии, которая интегрируется с VS2010, и, судя по сообщению на форуме , они не собираются выпускать ее. Их Документ X! продукт, однако, звучит как то, на что вы должны взглянуть. Электронная версия доступна для скачивания здесь .

5 голосов
/ 20 июня 2010

Я помню, что примерно год назад некоторые люди на форуме Джоэла "Бизнес программного обеспечения" рекомендовали HelpNDoc .

Обсуждение на форуме: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10

1 голос
/ 12 мая 2012

Если аудитория для вашего файла справки - пользователь html help 2 приложения, который нельзя использовать, вам все равно нужно будет создать файл chm.Инструментом, который может сделать это для вас из приложения winforms, является Генератор справки для Visual Studio , который отнимает много работы по подготовке справки и привязке ее к формам.

1 голос
/ 15 февраля 2011

ghost doc с documentx или sandcastle - это то, что нужно ... Отдых все еще очень примитивен, когда дело доходит до 2010 года. Если у вас есть проект как на c #, так и на C ++, то documentx будет подходить, если это просто C #, тогда любойэто хорошо.

1 голос
/ 26 июня 2010

Как уже говорили другие, вы можете преобразовать справку в стиле MSDN с тройным слешем, используя Sandcastle, для всех членов и объектов уровня класса 

/// <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

A более многофункциональный генератор справки, который интегрируется с Visual Studio 2010 и генерирует несколько форматов справки VSDocMan .Он включает в себя редактор комментариев WYSIWYG и фактически комментирует часть вашего кода для вас.Чрезвычайно полезный

0 голосов
/ 28 июля 2010

Только что провел много исследований, и после тестирования различных инструментов http://www.helpgenerator.com/ - самый быстрый способ собрать справочную систему.

0 голосов
/ 26 июня 2010

Html Help, заменяется Html Help 2.

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

0 голосов
/ 20 июня 2010

Вероятно, не интегрируется с VS2010, но я помню, что использовал RoboHelp примерно в 97-м, и это было нормально: тогда, поэтому, если бы мне нужно было написать справочные файлы сейчас, я бы, вероятно, дал другой взгляд, так как кажется, что он все еще существует здесь . Кажется, это довольно дорого, но если у вас есть несколько лицензий Adobe (что не является чем-то необычным для магазина разработки) по какой-то другой причине, может быть, вы уже получили это?

...