.Net XML-комментарий в документации по API
Есть ли простой способ создать документацию в стиле MSDN из выходных данных Visual Studio XML?
У меня недостаточно терпения, чтобы настроить для этого хороший xslt, потому что я знаю, что я не первый, кто пересекает этот мост.
Кроме того, я недавно пробовал построить замок из песка, но это действительно заставило меня коситься. Либо я упустил что-то важное в процессе, либо это слишком сложно.
Я знаю, что у кого-то есть действительно хорошее и простое решение.
Я повторяю здесь, потому что думаю, что мое форматирование сделало этот абзац непривлекательным для чтения:
I gave sandcastle a try but had a really hard time getting it set up. What I really have in mind is something much simpler.
То есть, если я просто не понимаю процесс замков из песка. Мне показалось, что создание чего-то приятного для тестировщиков - это слишком много лишнего багажа.
Ответы 6
Вы ищете Sandcastle
Страница проекта: Релизы Sandcastle
Блог: Блог Sandcastle
Генератор документации кода NDoc для .NET раньше был предпочтительным инструментом, но поддержка практически прекратилась.
Взгляните на замок из песка, который делает именно это. Это также одно из более простых решений, и это более или менее предпочтительный инструмент, поэтому в долгосрочной перспективе, возможно, мы могли бы помочь вам настроить Sandcastle, если вы укажете, с какими проблемами вы столкнулись во время установки?
Я только что снова построил Sandcastle. Попробуйте установить его (выпуск от мая 2008 г.) и найдите SandcastleGui.exe или что-то подобное (оно находится в папке с примерами или около того).
Нажмите «Добавить сборку» и добавьте свою сборку или сборки, добавьте любые XML-файлы документации (те, которые были созданы компилятором, если вы включили этот параметр), а затем «Сборка».
Это займет некоторое время, но результат буду стоит затраченных усилий. На самом деле он будет искать материалы из MSDN, поэтому ваша итоговая документация также будет иметь Class Inheritance вплоть до System.Object со ссылками на MSDN и так далее.
Поначалу Sandcastle кажется немного сложным, особенно если вы хотите использовать его в автоматизированной сборке, но я абсолютно уверен, что это того стоит.
Также взгляните на Конструктор файлов справки Sandcastle, это несколько более продвинутый графический интерфейс для него.
Следуйте эта простая статья из 5 шагов, и все готово. В качестве бонуса вы можете использовать H2Viewer для просмотра файлов Html Help 2.x.
Вам также следует использовать конструктор файлов справки Sandcastle. Он предоставляет вам графический интерфейс, подобный ndoc, для создания файлов справки, поэтому вам не нужно ничего делать из командной строки.
Добро пожаловать в проект создания файлов справки Sandcastle
Я использую NDoc3