Какие инструменты доступны для создания файла справки в Visual Studio 2010?
Мне нужно написать файл справки для приложения WinForms в Visual Studio 2010. В идеале я хотел бы использовать инструмент, который интегрируется с Visual Studio, а не совершенно отдельный инструмент.
Раньше я использовал HTML Help Workshop, но это уже давно, и я помню, что это было немного забавно в использовании. Я также знаю, что в Visual Studio 2005 SDK был встроен инструмент, но мне нужно кое-что для 2010 года.
9 ответов
Это неловкая цель для поставщиков инструментов. В большинстве магазинов справка написана профессиональными авторами, которые не используют Visual Studio в своей повседневной деятельности. Сторонние инструменты авторинга, такие как RoboHelp, являются их предпочтительным оружием.
Инструмент VS2005 SDK, который вы, вероятно, видели, - HelpStudio Lite, продукт Innovasys. Нет доступной версии, которая интегрируется с VS2010, и, судя по сообщению на форуме, она не собирается выпускать ее. Их Документ X! продукт, однако, звучит как то, на что вы должны взглянуть. Версия eval доступна для скачивания здесь.
Вот ваши варианты...
Если вам нужен генератор документации Microsoft с интеграцией VS:
- Sandcastle Help File Builder для создания файла справки
- DocProject для интеграции его в VS
Хотя, похоже, DocProject пока не совсем поддерживает VS2010.
Для решения не от MS есть GhostDoc, который поддерживает интеграцию с VS 2010 и представляется лучшим решением.
Для параметров, которые не интегрируются в Visual Studio:
Я помню, что примерно год назад некоторые люди на форуме Джоэла "Бизнес программного обеспечения" рекомендовали HelpNDoc.
Обсуждение на форуме: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10
Если аудитория для вашего файла справки - это пользователь html help 2, который нельзя использовать, вам все равно нужно будет создать файл chm. Инструментом, который может сделать это для вас из приложения winforms, является Help Generator для Visual Studio, который отнимает много работы по подготовке справки и привязке ее к формам.
ghost doc с documentx или sandcastle - это то, что нужно... Отдых все еще очень примитивен, когда дело доходит до 2010 года. Если у вас есть проект как на C#, так и на C++, то documentx будет подходить, если это просто C#, тогда любой из них хорош.
Как уже говорили другие, вы можете преобразовать справку в стиле 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
VSDocMan - это более многофункциональный генератор справки, который интегрируется с Visual Studio 2010 и генерирует несколько форматов справки. Он включает в себя редактор комментариев WYSIWYG и фактически комментирует часть вашего кода для вас. Очень полезно
http://www.helpgenerator.com/ - это самый быстрый способ собрать систему помощи.
Вероятно, не интегрируется с VS2010, но я помню, что использовал RoboHelp примерно в 97-м, и это было нормально: тогда было бы так, если бы мне нужно было написать файлы помощи сейчас, я бы, вероятно, дал другой взгляд, так как кажется, что он все еще здесь. Кажется, это довольно дорого, но если у вас есть какие-то лицензии Adobe (что не является чем-то необычным для магазина разработки) по какой-то другой причине, может быть, вы уже получили это?
Html Help, заменяется Html Help 2.