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

StackOverflow https://stackoverflow.com/questions/3077361

Вопрос

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

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

Это было полезно?

Решение

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

SDK SDK VS2005, который вы, вероятно, видели, было HelpStudio Lite, продукт инновалов. Нет доступной версии, которая интегрируется с VS2010 и судя по Форум пост Они не намерены выпускать один. Их документ х! Продукт, однако, звучит как то, на что вы должны взглянуть. Eval Version доступен для скачивания отсюда.

Другие советы

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

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

Хотя, кажется, что DOCPROJECT не совсем поддерживает VS2010.

Для решения не-МС есть Ghostdoc., который делает Поддержка VS 2010 Integration и, по-видимому, является лучшим решением.

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

Я помню, что в год или около того назад некоторые люди на joel есть бизнес программного форума, рекомендовали Helpndoc..

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

Поскольку другие сказали, вы можете конвертировать Triple Slash XML 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){
...

Вот ссылка на Песок

А. больше богатых функциями Помогите генератору этому Интеграты с Visual Studio 2010 и генерирует несколько форматов справки Vsdocman Отказ Он включает в себя редактор комментариев Wysiwyg и на самом деле комментирует некоторые из ваших кодов для вас. Очень полезно

Docost Doc с DocumentX или Sandcastle - это путь к отправке ... Отдых все еще очень примитив, когда он доходит до 2010 года. Если у вас есть проект как C #, так и C ++, то DocumentX будет так, если это просто C #, то любой хороший.

Если аудитория для вашего файла справки - пользователь приложения HTML HELP 2 не используется, вам все равно нужно будет создать файл CHM. Инструмент, который может сделать это для вашего приложения WinForms, Генератор помощи для Visual Studio, который убирает много работы в подготовке помощи и связывая его к формам.

Вероятно, не интегрируется с VS2010, но я помню, как обратно используя Robohelp вокруг '97, и это было нормально: ish, поэтому, если мне нужно было написать Helliesfiles теперь, я, вероятно, дал это еще один взгляд, поскольку кажется, что это все еще здесь. Отказ Дорого дороже, хотя похоже, но если у вас есть некоторые лицензии Adobe (которые не совсем не оказаны для разработки магазина) по какой-то другой причине, возможно, вы уже получили это?

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

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

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

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top