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