Программирование - это просто
Advertisement
Главная arrow Уроки C# arrow Приемы, рецепты и полезные советы по C#. arrow Полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio.
06.10.2022 г.
Главное меню
Главная
Интернет магазин
Программные продукты
Биржевые роботы
Искусственный интеллект
Математика и информатика
1С:Предприятие
Уроки C#
Уроки Delphi
Уроки программирования
Web-программирование
Дизайн и графика
Компьютер для блондинок
Исходники
Статьи
Платный раздел
Рассказы про компьютеры
Хитрости и секреты
Системный подход
Размышления
Наука для чайников
Друзья сайта
Excel-это не сложно
Все о финансах
.
Полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio. Печать E-mail
Автор megabax   
12.04.2012 г.
В этой статье я постараюсь максимально просто и понятно изложить основы программирования на языке Delphi

Приемы, рецепты и полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio.

На прошлом уроке мы научились создавать XML-документацию. Сегодня изучим, как из XML файла документации создать полноценный файл справки. В рамках данного урока мы рассмотрим создание файла справки на примере "Sandcastle Help File Builder", который состоит из двух утилит, их можно скачать отсюда:

После того, как мы скачали и установили Sandcastle можно приступать к созданию файла справки. И так, запускаем прогу и создаем в ней новый проект через меню "Project" -> "New Project from visual Studio Project":

Приемы, рецепты и полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio.

После этого программа попросит у вас выбрать файл проекта решения Visual Studio. Выберете его. Естественно, проект Visual Studio должен быть уже скомпилирован (см. прошлый урок) и содержать файл XML-документации.

После выбора проекта Visual Studio у вас нужные файлы добавятся в проект Sandcastle:

Приемы, рецепты и полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio.

 Далее необходимо настроить параметры проекта Sandcastle. Вот описание наиболее важных опций:

Параметр

Значение

Описание

Additional and Conceptual Content

AdditionalContent

В дополнительно открывшемся окне добавьте при помощи кнопки «File» наши страницы Index.htm и Details.htm.

Дополнительные статические HTML страницы.

Build

ComponentConfigurations

Выберите в открывшемся окне Code Block Component.

Мы его используем для подсветки синтаксиса из статической страницы.

FrameworkVersion

2.0.50727

Укажите здесь используемую в приложении версию .Net

HelpFileFormat

Help1xAnd2xAndWebsite

Выберите один или несколько выходных форматов: HtmlHelp1x/HtmlHelp2x/WebSite.

Help File

HelpTitle

Тестовое консольное приложение

Наш заголовок

HtmlHelpName

HelloWorldApplication

Имя выходного файла справки

PresentationStyle

vs2005

Тут уж на ваше предпочтение, мне привычней «vs2005» вместо «hana» или «Prototype»

RootNamespaceContainer

True

Мы отделим наше описание классов в отдельный узел справки

RootNamespaceTitle

Namespaces

и дадим ему наше имя

Paths

HtmlHelp1xCompilerPath

C:\Program Files\HTML Help Workshop\

Путь к HTML Help Workshop and Documentation

HtmlHelp2xCompilerPath

C:\Program Files\Common Files\Microsoft Shared\Help 2.0 Compiler\

Путь к «Microsoft Help SDK», который устанавливается с Visual Studio SDK (2003/2005/2008), например, Visual Studio 2008 SDK 1.1

OutputPath

.\HelpResult\

Путь, куда будет скопирована готовая документация

SandcastlePath

C:\Program Files\Sandcastle\

Путь к Sandcastle, скорректируйте его в соответствии с вашими установками

WorkingPath

.\SandcastleWorkingFolder\

Путь к рабочей папке, где будут складываться промежуточные результаты работы

Так же можно включить в проект дополнительную информацию: обратный адрес, свои авторские права и так далее:

Приемы, рецепты и полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio.

И данная информация у вас отобразиться в справке:

Приемы, рецепты и полезные советы по C#. Урок 3. Создание файла справки к своим проектам на Visual Studio.

 

 

 

Последнее обновление ( 12.04.2012 г. )
 
« След.   Пред. »
 
© 2022 Программирование - это просто
Joomla! - свободное программное обеспечение, распространяемое по лицензии GNU/GPL.
Русская локализация © 2005-2008 Joom.Ru - Русский Дом Joomla!
Design by Mamboteam.com | Powered by Mambobanner.de
Я принимаю Яндекс.Деньги