My<cod/>.net
.Net XML комментарий к документации API
Существует ли простой способ создать документацию в стиле MSDN из выходных данных Visual Studio XML?
Я не настолько терпелив, чтобы создать хороший xslt для этого, потому что я знаю, что я не первый человек, который пересек этот мост.
Кроме того, я недавно пытался установить замок из песка, но это действительно заставило меня скосить глаза. Либо я упустил что-то важное в этом процессе, либо он просто слишком вовлечен.
Я знаю, что у кого-то там есть действительно хорошее мертвое простое решение.
Я повторяю здесь, потому что я думаю, что мое форматирование сделало этот абзац неинтересным для чтения:
Я дал Сэнд-Кастлу попробовать, но мне было очень трудно его настроить. На самом деле я имею в виду нечто гораздо более простое.
То есть, если только я просто не понимаю процесс создания песчаного замка. Мне казалось, что это ужасно много дополнительного багажа, чтобы просто произвести что-то хорошее для тестировщиков, чтобы работать с ними.
Вы ищете замок из песка
Страница Проекта: Релизы Sandcastle
Блог: Блог Сандкасл
NDoc генератор документации кода для .NET раньше был инструментом выбора, но поддержка практически прекратилась.
Взгляните на замок Сэнд, который делает именно это. Это также одно из более простых решений, и это более или менее инструмент выбора, так что в долгосрочной перспективе, может быть, мы могли бы помочь вам настроить Sandcastle, если вы укажете, с какими проблемами вы столкнулись во время установки?
Вы также должны использовать конструктор файлов справки Sandcastle. Он предоставляет вам ndoc, как GUI для создания файлов справки, так что вам не нужно ничего делать из командной строки.
Добро пожаловать в проект Sandcastle Help File Builder
Я только что снова построил замок из песка. Попробуйте установить его (май 2008 года выпуска) и поискать SandcastleGui.exe или что-то подобное (это в папке примеров или около того).
Нажмите кнопку Добавить Assembly и добавьте свои Assembly или сборки, добавьте любые файлы документации .xml (те, которые были созданы компилятором, если вы включили эту опцию), а затем постройте.
Это займет некоторое время, но результат будет стоить затраченных усилий. На самом деле он будет искать материал от MSDN, так что ваша результирующая документация также будет иметь наследование класса вплоть до System.Object со ссылками на MSDN и прочее.
Сначала замок из песка кажется немного сложным, особенно если вы хотите использовать его в автоматизированной сборке, но я абсолютно уверен, что это будет стоить усилий.
Также посмотрите на Sandcastle Help File Builder, это несколько более продвинутый GUI для него.
Следуйте этой простой 5-шаговой статье , и вы почти все сделали. В качестве бонуса вы можете использовать H2Viewer для просмотра Html файлов справки 2.x.