Комментарий .Net XML в документацию API
Существует ли простой способ создания документации в стиле MSDN из XML-вывода Visual Studio?
Я'не достаточно терпелив, чтобы создать хороший xslt для этого, потому что я знаю, что я'не первый, кто пересекает этот мост.
Кроме того, я недавно пытался настроить sandcastle, но это действительно заставило мои глаза пересечься. Либо я упустил что-то важное в процессе, либо это просто слишком сложно.
Я знаю, что у кого-то есть действительно хорошее и простое решение.
Я повторяюсь, потому что, по-моему, мое форматирование сделало этот абзац неинтересным для чтения:
Я попробовал sandcastle, но мне было очень трудно его настроить. На самом деле я имею в виду нечто гораздо более простое.
То есть, если только я просто не понимаю процесс создания sandcastle. Мне кажется, что для того, чтобы создать что-то хорошее для работы тестеров, нужно очень много дополнительного багажа.
Вы'ищете Sandcastle
Страница проекта: Sandcastle Releases
Блог: Sandcastle Blog
NDoc Code Documentation Generator for .NET раньше был самым популярным инструментом, но его поддержка практически прекратилась.
Посмотрите на Sandcastle, который делает именно это. Это также одно из более простых решений, и это более или менее подходящий инструмент, так что в конечном итоге, возможно, мы могли бы помочь вам настроить Sandcastle, если вы укажете, с какими проблемами вы столкнулись при настройке?
Вы должны также использовать Строителя Справочного файла Замка из песка. Это предоставляет Вам ndoc как графический интерфейс пользователя для создания справочных файлов так Вы don' t должны сделать что-либо от командной строки.
Добро пожаловать в проект строителя справочного файла замка из песка
Я'только что снова установил Sandcastle. Попробуйте установить его (релиз от мая 2008 года) и найдите SandcastleGui.exe или что-то подобное (он находится в папке examples или около того).
Нажмите Add Assembly и добавьте вашу сборку или сборки, добавьте любые .xml Documentation файлы (те, которые генерируются компилятором, если вы включили эту опцию) и затем Build.
Это займет некоторое время, но результат **будет стоить затраченных усилий. Он действительно будет искать материал в MSDN, так что ваша итоговая документация будет содержать наследование классов вплоть до System.Object со ссылками на MSDN и прочее.
Sandcastle поначалу кажется немного сложным, особенно когда вы хотите использовать его в автоматизированной сборке, но я абсолютно уверен, что это будет стоить затраченных усилий.
Также взгляните на Sandcastle Help File Builder, это несколько более продвинутый графический интерфейс для него.
Я использую NDoc3