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

Question

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

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

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

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

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

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

Answer 1

Вы ищете Sandcastle

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

Блог: Блог Sandcastle

Генератор документации кода NDoc для .NET раньше был инструментом выбора, но поддержка почти прекратилась.

Answer 2

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

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

Answer 3

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

Answer 4

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

Answer 5

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

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

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

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

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

Answer 6

Я использую NDoc3