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

Question

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

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

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

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

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

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

Answer 1

Вы ищете Замок из Песка

Страница проекта: Релизы Песочного Замка

Блог: Блог о Замке из песка

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

Answer 2

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

Answer 3

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

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

Answer 4

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

Answer 5

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

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

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

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

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

Answer 6

Я использую NDoc3