XML-комментарий .Net в документацию API

Существует ли простой способ создания документации в стиле MSDN из выходных данных Visual Studio XML?
Я не достаточно терпелив, чтобы настроить хороший xslt для этого, потому что я знаю, что я не первый человек, который пересекает этот мост.

Кроме того, я недавно попытался настроить замок из песка, но это действительно заставило меня пересечь глаза. Либо я упустил что-то важное в процессе, либо это слишком сложно.

Я знаю, что у кого-то есть действительно милое, простое решение.

Я повторяю здесь, потому что я думаю, что мое форматирование сделало этот абзац непривлекательным для чтения:

Я попробовал sandcastle, но мне было очень трудно его настроить. То, что я действительно имею в виду, - это нечто гораздо более простое.

То есть, если я просто не понимаю процесс сандкасл. Мне показалось, что это очень много лишнего багажа, просто чтобы создать что-то приятное для тестеров.

3.08.2008 22:03:37
6 ОТВЕТОВ
РЕШЕНИЕ

Вы ищете Сандкасл

Страница проекта: релизы Sandcastle

Блог: Блог Sandcastle

Раньше NDoc Code Documentation Generator для .NET использовался как инструмент выбора, но поддержка практически прекратилась.

10
28.01.2013 03:56:05

Посмотрите на Sandcastle , который делает именно это. Это также одно из более простых решений и более или менее предпочтительный инструмент, так что в конечном итоге, возможно, мы могли бы помочь вам настроить Sandcastle, если вы укажете, с какими проблемами вы столкнулись во время установки?

5
3.08.2008 22:24:57

Вам также следует использовать конструктор файлов справки Sandcastle. Он предоставляет вам графический интерфейс, похожий на ndoc, для генерации файлов справки, поэтому вам не нужно ничего делать из командной строки.

Добро пожаловать в проект построителя файла справки Sandcastle

5
28.01.2013 03:54:28

Следуйте этой простой статье из 5 шагов, и вы в значительной степени готовы. В качестве бонуса вы можете использовать H2Viewer для просмотра Html Help 2.x файлов.

4
4.08.2008 10:31:33

Я только что снова установил Sandcastle. Попробуйте установить его (выпуск за май 2008 г.) и найдите SandcastleGui.exe или что-то подобное (он находится в папке примеров или около того).

Нажмите «Добавить сборку» и добавьте свою сборку или сборки, добавьте все файлы XML-документации (файлы, сгенерированные компилятором, если вы включили эту опцию), а затем «Сборка».

Это займет некоторое время, но результат будет стоить усилий. На самом деле он будет искать вещи из MSDN, поэтому ваша итоговая документация также будет иметь наследование классов вплоть до System.Object со ссылками на MSDN и прочее.

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

Также взгляните на Sandcastle Help File Builder , это несколько более продвинутый графический интерфейс для него.

4
7.02.2013 17:31:19

Я использую NDoc3

2
21.02.2010 22:12:47