Help_File в C#

Question

Я использую MS Visual Studio Pro 2012 и хочу создать какой-нибудь файл справки.

Я думал о создании html-файла, как этот, но мой вопрос: нужно ли мне всегда иметь html-файл в этом каталоге, даже после того, как у меня создан файл.EXE или файл html добавлен в файл.EXE?

Если нет, как это можно сделать?

[.NET Framework 4.5 | Windows Forms]

РЕДАКТИРОВАТЬ: Я хочу загрузить данный (локальный) HTML-файл в веб-браузере по умолчанию. Этот файл должен быть "внутри" .EXE файл.

Answer 1

Преимущество наличия отдельного HTML-файла заключается в том, что вы можете обновить его самостоятельно, не выдвигая новую сборку. Однако, если вы хотите встроить его в EXE, вы можете перейти к свойствам вашего проекта, а затем нажать на Resources, Добавьте существующий файл (ваш HTML-файл), и теперь он будет доступен из вашего кода.

Когда вы хотите открыть его, вы можете сделать что-то вроде этого

string html = Resources.MyHelpFile;
if (!File.Exists("tmpHelp.html"))
{
   using (var tmpFile = File.CreateText("tmpHelp.html"))
   {
      tmpFile.Write(html);
   }
}

Process.Start("tmpHelp.html");

Затем вы можете удалить файл справки на более позднем этапе, например, когда пользователь закрывает ваше приложение.

Answer 2

Я рекомендую использовать HTML Help Workshop для создания файла справки. а затем использовать Help.ShowHelp();, Это намного проще

Но для вашего случая. Вы можете сделать как KeyboardP предложил или переместить файл в свой bin/Debug папку, а затем использовать

    Process.Start("helpname.html");

ПРИМЕЧАНИЕ. Вам также понадобится добавить файл в папку приложения при создании настроек.

Answer 3

Вы можете создать html-файл (я думаю, что самый простой способ - это создать его с помощью Microsoft Word и сохранить как html). Затем вы создаете новую форму, содержащую инструмент webBrowser, и задаете URL для вашего пути к html-файлу, например так:

string filepath = Environment.CurrentDirectory + @"\Help.htm";
Uri uri = new Uri(filepath);
webBrowser_Help.Navigate(uri);

Answer 4

Если вы хотите создать файл справки из Visual Studio, почему бы не посмотреть на:

http://shfb.codeplex.com/

Sandcastle создаст ваш файл справки на основе комментариев, которые вы написали о ваших классах и методах. Хит вперед косая черта три раза (например, /) над объявлением вашего класса или метода, и появится поле для комментариев. Заполните существенные детали, запустите Sandcastle, и ваш файл справки будет создан.