Аннотация:
Sandcastle — проект, цель которого — предоставить разработчикам библиотек классов по всему миру средство простого создания точной и информативной документации общепринятого вида.
Здравствуйте, nzeemin, Вы писали:
N>Есть, правда, и ложка дёгтя. ReflectionToChmContents.xsl и ReflectionToChmIndex.xsl не работают, поскольку пытаются записать кириллицу в кодировку Latin-1. А значит, .chm-файл нам не получить. Написал им на форум. Будем посмотреть…
Достаточно там прописать вместо latin-1 UTF8 и все работает.
Re: Sandcastle - Новый генератор документации для .NET
test.cs — исходный файл примера из папки Sandcastle: Examples\Sandcastle\test.cs
test.dll — скомпилированный пример
comments.xml — файл XML-комментариев, полученный при компиляции
doc.build — скрипт сборки для NAnt
go.bat — командник для запуска doc.build под NAnt
Использование: Распаковываем в какую-нибудь папку на диске
Настраиваем пути в doc.build
Запускаем: go build
В результате в папке "C:\Program Files\Sandcastle\Examples\My" создается структура каталогов HTML-файлы и другие файлы, приготовленные для сборки справки. Сборка идет в эту папку для того, чтобы не возиться с путями в файлах Sandcastle.config.
Запускаем go build-chm
В результате получаем файл "C:\Program Files\Sandcastle\Examples\My\Output\test.chm".
Примечание: описанный в статье инвертор для hhc.exe я не ставил, поэтому результат сборки всегда будет FAILED.
Параметр var.Presentation в doc.build задает используемый шаблон.
Для совсем ленивых — в тот же архиве лежат готовые .chm, сделанные на разных шаблонах:
Задался вопросом — а как бы мне получить с помощью Sandcastle документацию на русском? Т.е. чтобы весь шаблон документации был русифицирован. Оказалось, всё не просто, а очень просто. И в этом смысле Sandcastle намного превосходит NDoc.
В папке Sandcastle\Presentation делаем копию папки vs2005 под именем vs2005ru. В новом шаблоне, в папке Content переводим содержимое трёх небольших XML-файлов на русский, считая что эти файлы записаны в UTF-8. В Configuration\sandcastle.config заменяем имя папки vs2005 на vs2005ru. В copyOutput.bat делаем то же самое.
поставить в качестве имени шаблона vs2005ru и прогнать процесс создания HTML-файлов.
Есть, правда, и ложка дёгтя. ReflectionToChmContents.xsl и ReflectionToChmIndex.xsl не работают, поскольку пытаются записать кириллицу в кодировку Latin-1. А значит, .chm-файл нам не получить. Написал им на форум. Будем посмотреть…
Re: Sandcastle - Новый генератор документации для .NET
От:
Аноним
Дата:
13.01.07 07:09
Оценка:
Здравствуйте, Никита Зимин, Вы писали:
Важное отличие этого процесса от процесса NDoc: в Sandcastle основой всегда является сборка, на основе мета-информации сборки строится весь справочник, файл XML-комментариев является необязательным;
Но тем не менее при добавлении сборки в список необходимо указывать и имя XML файла. Без него не добавляется. Если указать неверный XML, то при билде ошибка
BUILD FAILED: Unable to find XML comments file: Unknown.xml
Re[2]: Sandcastle - Новый генератор документации для .NET
От:
Аноним
Дата:
13.01.07 07:37
Оценка:
Здравствуйте, Аноним, Вы писали:
А>Здравствуйте, Никита Зимин, Вы писали:
А>
А>Важное отличие этого процесса от процесса NDoc: в Sandcastle основой всегда является сборка, на основе мета-информации сборки строится весь справочник, файл XML-комментариев является необязательным;
Опять же непонятно, если инфа берется из сборки, то зачем вручную указывать папку с Dependences? Без указания опять ошибка, что не найдены внешние сборки.
Кстати, возможно ли генерить доки только из основной сборки, не затрагивая остальное ?
Re: Sandcastle - Новый генератор документации для .NET
А не подскажете, как в коде программы можно указывать summary для namespace? В частности в NDoc для этого заводился класс NamespaceDoc, и его summary использовался в качестве summary для namespace.
... << RSDN@Home 1.1.4 stable SR1 rev. 568>>
Re: Sandcastle - Новый генератор документации для .NET
Здравствуйте, Никита Зимин, Вы писали:
НЗ>Аннотация: НЗ>Sandcastle — проект, цель которого — предоставить разработчикам библиотек классов по всему миру средство простого создания точной и информативной документации общепринятого вида.