НЗ>Статья:
НЗ>Sandcastle — Новый генератор документации для .NET

Автор(ы): Никита Зимин
Дата: 23.11.2006
Sandcastle — проект, цель которого — предоставить разработчикам библиотек классов по всему миру средство простого создания точной и информативной документации общепринятого вида.

Еще в ходе написания статьи многие хотели посмотреть на пример — как процесс выглядит в натуре и каков результат.

http://rsdn.ru/File/10885/TestSandcastle.zip

• test.cs — исходный файл примера из папки Sandcastle: Examples\Sandcastle\test.cs
  
• test.dll — скомпилированный пример
  
• comments.xml — файл XML-комментариев, полученный при компиляции
  
• doc.build — скрипт сборки для NAnt
  
• go.bat — командник для запуска doc.build под NAnt

Использование:

1. Распаковываем в какую-нибудь папку на диске
   
2. Настраиваем пути в doc.build
   
3. Запускаем: go build
   В результате в папке "C:\Program Files\Sandcastle\Examples\My" создается структура каталогов HTML-файлы и другие файлы, приготовленные для сборки справки. Сборка идет в эту папку для того, чтобы не возиться с путями в файлах Sandcastle.config.
   
4. Запускаем go build-chm
   В результате получаем файл "C:\Program Files\Sandcastle\Examples\My\Output\test.chm".
   Примечание: описанный в статье инвертор для hhc.exe я не ставил, поэтому результат сборки всегда будет FAILED.

Параметр var.Presentation в doc.build задает используемый шаблон.

Для совсем ленивых — в тот же архиве лежат готовые .chm, сделанные на разных шаблонах:

• test-Prototype.chm
  
• test-vs2005.chm