воскресенье, 10 декабря 2006 г.

Генератор документации для .NET Sandcastle

Средства генерирования документации меня занимают давно. Когда проблема стояла остро, я нашел Doxygen и больше ничего не рассматривал, так как полностью удовлетворил все мои запросы к таким инструментам. Программировал я в то время не столько на .NET, сколько на других языках, поэтому Doxygen подошел как нельзя лучше.

Скорее всего, из-за отсутствия потребности в .NET ориентированном генераторе, появление и развитие популярного NDoc, прошло мимо меня.

В настоящее время я активно присматриваюсь к Sandcastle от Microsoft и ниже подборка информации по этому проекту.

Лучше всего начать с отличной статьи Никиты Зимина на RSDN: Новый генератор документации для .NET. В его блоге можно найти информацию по локализации Sandcastle.

Остальные источники англоязычные, в основном пересекающиеся с источниками из статьи Никиты.

Презентация (не пропустите комментарии к слайдам) от автора системы, разъясняющая основные положения Sandcastle. Блог разработчиков. Форум на MSDN. Wiki проекта.

Статья по добавлению генерации документации Sandcastle в NAnt и еще одна на CodeProject: Generating MSDN-style documentation with Sandcastle, NAnt and CruiseControl.NET.

Пошаговая инструкция по генерации Chm и генератор BAT-файлов для автоматизации выполнения шагов инструкции (блог автора)

Для работы с SandCastle пригодится HTML Help Workshop, если он вдруг еще не стоит в системе.

Sandcastle Help File Builder - проект на CodePlex, дополняющий Sandcastle некоторыми возможностями NDoc и предоставляющий GUI в его стиле. Статья автора по использованию. И еще одна подробная статья: How To Generate Help Files for Your .NET Application Using Sandcastle Help File Builder.

MSBuild скрипты для Sandcastle - проект на CodePlex и блог автора для автоматизации генерации документации с помощью MSBuild.

Power Shell Script - скрипт Scott Hanselman для PowerShell и небольшой обзор.

SandCastle documentation cleaner - небольшая утилита для удаления частей документации, которые не предполагалось публиковать, например, помеченных как internal.

Addin для Visual Studio, позволяющий генерировать документацию в SandCastle непосредственно из Visual Studio.

Technorati tags: ,
Blogus tags : ,

Комментариев пока нет