Sandcastle Help File Builder - генериране на документация за
Основни характеристики на Sandcastle
Подготовка за работа
Тестови проект за документация
пространство от имена Atv.Research.HelloWorld /// /// Базов клас на тестово приложение /// публичен клас Програма /// /// Метод за стартиране на конзолно приложение /// ///
Аргументи на конзолното приложение
public static void Main( string [] args) Console .Out.WriteLine( "Hello World!"); > > > * Този изходен код беше маркиран с инструмента за открояване на изходния код.
Нека веднага добавим няколко статични страници към нашата документация. Често се случва техническата информация от кода да не е достатъчна. Необходими са по-общи описания, със снимки и диаграми. Или, например, трябва да вмъкнете целия текст на конфигурационен файл или WSDL за уеб услуга. Като пример ще вмъкнем 2 статични HTML страници. Един от тях ще бъде отправна точка за нашата документация.
DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" > html xmlns ="http://www.w3.org/1999/xhtml" > глава > заглавие > относно заглавието > глава > тяло > div style="height:140px;" > div > div style="text-align:center" > h1 > Тествайте конзолно приложение br /> Здравей свят! h1 >
div > a href="Подробности.htm" > Подробно описание a > div > div >
тяло > html > * Този изходен код беше маркиран с инструмента за открояване на изходния код.
DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" > html xmlns="http://www.w3.org/1999/xhtml" > глава > заглавие > Заглавие на подробности > глава > тяло > h2 > Предназначение h2 > p > Тестовото конзолно приложение "Hello World" има за цел да демонстрира възможностите на Sandcastle. p > h2 > Пример за връзки към автодокументация h2 > Следният тестов клас е добавен към конзолното приложение като пример: вижте cref ="Atv.Research.HelloWorld.MyTestClass" />
h2 > Пример за осветяване на синтаксис с помощта на "компонента на кодовия блок" h2 > pre lang ="cs" numberLines ="true" outlining ="true" title ="Пример за подчертаване на синтаксиса" > // Метод за тестване public void TestMethod(string s, int x) // Код за отстраняване на грешки x = x + 1; s = x.ToString(); Console.WriteLine("Низът = " + s); > преди >
тяло > html > * Този изходен код беше маркиран с инструмента за открояване на изходния код.
- ще направи подчертаване на синтаксиса в примери за код за статични страници. Тези и други вградени функции са описани в документацията на Sandcastle Help File Builder.
Стартиране на програмата
Резултати от работата
1. Microsoft Compiled HTML Help (CHM)
Помощ за CHM
CHM помощ - статична страница
2. Помощ за MS Microsoft 2
Интегрирана помощ във формат MSDN
3. Статичен уебсайт
Помощ в обикновени HTML страници
4. Динамичен уебсайт (ASP.NET)
Помощ под формата на динамичен сайт с търсене
Допълнителна информация
Можете да намерите всички кодове, използвани по-горе, проекта Help File Builder и резултатите от неговата работа в архива SandcastleTestProject.zip наnarod.yandex.ru или drop.io (391KB).
Връзки за допълнително проучване:
- Sandcastle на CodePlex
- Sandcastle Help File Builder на CodePlex
- XML документация в C# на Habré
Hardcore conf в C++. Каним само професионалисти.