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

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

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

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

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

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

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

Ответы

Ответ 2

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

Ответ 3

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

Добро пожаловать в проект Builder Builder Sandcastle

Ответ 4

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

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

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

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

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

Ответ 5

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

Ответ 6

Я использую NDoc3