Мне нужно написать файл справки для приложения WinForms в Visual Studio 2010. В идеале я хотел бы использовать инструмент, который интегрируется с Visual Studio, а не полностью отдельный инструмент.
Раньше я пользовался HTML Help Workshop, но он старый, и я помню, что пользоваться им было немного странно. Я также знаю, что в Visual Studio 2005 SDK был встроен инструмент, но мне нужно что-то для 2010.
это неудобная цель для поставщиков инструментов. В большинстве магазинов справка создается профессиональными авторами, которые не используют Visual Studio в своей повседневной деятельности. Сторонние авторские инструменты, такие как RoboHelp, являются их предпочтительным оружием.
Инструмент VS2005 SDK, который вы, вероятно, видели, был HelpStudio Lite, продуктом Инновасис. Нет доступной версии, которая интегрируется с VS2010 и, судя по сообщению на форуме они не собираются его выпускать. Их Документ X! Продукт, однако, звучит как то, на что вы должны взглянуть. Оценочную версию можно загрузить здесь.
Вот ваши варианты...
Если вам нужен генератор документации Microsoft с интеграцией с VS:
Однако похоже, что DocProject еще не полностью поддерживает VS2010.
Для решения, отличного от MS, есть GhostDoc, который поддерживает VS 2010 и кажется лучшим решением.
Для параметров, которые не интегрируются в Visual Studio:
Я помню, как год назад некоторые люди на форуме Джоэла «Бизнес программного обеспечения» рекомендовали 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 и фактически комментирует часть вашего кода для вас. Очень полезно
Призрачный документ с documentx или замком из песка - это путь ... Остальное все еще очень примитивно, когда дело доходит до 2010 года. Если у вас есть проект как на C #, так и на C ++, тогда documentx будет путь, если это просто C #, то любой из них хорош.
Если аудиторией вашего файла справки является пользователь приложения, справка html 2 непригодна для использования, вам все равно потребуется создать файл chm. Инструмент, который может сделать это для вас из вашего приложения winforms, — это Генератор справки для Visual Studio, которая требует много работы по подготовке справки и связыванию ее с формами.
Вероятно, не интегрируется с VS2010, но я помню, как использовал RoboHelp где-то в 97-м, и тогда это было нормально, поэтому, если бы мне нужно было написать файлы справки сейчас, я бы, вероятно, взглянул на это по-другому, поскольку кажется, что он все еще существует здесь. Хотя это кажется довольно дорогим, но если у вас есть несколько лицензий Adobe (что не совсем необычно для магазина разработки), по какой-то другой причине, может быть, у вас уже есть это?
HTML-справка заменена HTML-справкой 2.
http://www.mshelpwiki.com/wiki/tiki-index.php?page=Help2
Просто провел много исследований и после тестирования различных инструментов http://www.helpgenerator.com/ это самый быстрый способ собрать справочную систему.
