Какие инструменты доступны для создания справочного файла в Visual Studio 2010?
Я должен записать справочный файл для приложения WinForms в Visual Studio 2010. Идеально, я хотел бы использовать инструмент, который интегрируется с Visual Studio, а не полностью отдельным инструментом.
В прошлом я использовал Семинар Справки HTML, но это является древним, и я вспоминаю, что это было немного броско для использования. Я также знаю, что был инструмент, встроенный в SDK Visual Studio 2005, но мне нужно что-то на 2010.
7 ответов
это неудобная цель для поставщиков инструментов. В большинстве магазинов помощь создается профессиональными писателями, которые не используют Visual Studio в своей повседневной деятельности. Сторонние инструменты разработки, такие как RoboHelp, являются их предпочтительным оружием.
Инструмент VS2005 SDK, который вы, вероятно, видели, был HelpStudio Lite , продуктом Innovasys. Нет доступной версии, которая интегрируется с VS2010, и, судя по сообщению на форуме , они не собираются выпускать ее. Их Документ X! продукт, однако, звучит как то, на что вам следует взглянуть. Пробную версию можно загрузить отсюда .
Вероятно, не интегрируется с VS2010, но я помню, как использовал RoboHelp в 1997 году, и это было нормально: ну, тогда, если бы мне нужно было писать файлы справки сейчас, я бы, вероятно, дал это еще один взгляд, так как кажется, что он все еще где-то здесь . Довольно дорого, хотя это кажется, но если у вас есть несколько лицензий Adobe (что вполне нормально для магазина разработки) по какой-то другой причине, может быть, у вас уже есть это?
Вот ваши варианты...
Если вам нужен генератор документации от Microsoft с интеграцией в VS:
- Sandcastle Help File Builder для генерации файлов справки
- DocProject для интеграции в VS
Хотя, похоже, что DocProject еще не поддерживает VS2010.
Для не-MS решения есть GhostDoc, который действительно поддерживает интеграцию с VS 2010 и кажется лучшим решением.
Для вариантов, которые не интегрируются в Visual Studio:
Я помню, что год или около того назад некоторые люди на форуме Joel's The Business of Software рекомендовали HelpNDoc.
Обсуждение на форуме: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.10
Как говорили другие, вы можете преобразовать справку в стиле 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){
...
Вот ссылка на Sandscastle
более многофункциональный генератор справки, который интегрируется с Visual Studio 2010 и генерирует несколько форматов справки: VSDocMan . Он включает редактор комментариев WYSIWYG и фактически комментирует часть вашего кода за вас. Чрезвычайно полезно
Просто провел много исследований и после тестирования различных инструментов http://www.helpgenerator.com/ стал самым быстрым способом собрать справочную систему.