Как отформатировать документацию Visual Studio XML для отображения в Интернете

Question

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

Заранее спасибо!

Answer 1

Извлечение Sandcastle .

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

Википедия содержит больше информации и ссылок на дополнительные проекты, которые интегрируются с sandcastle.

---

Другой вариант (который, как представляется, гораздо проще в использовании) - document :

Генератор документации для .Net, который не сложен, неудобен или труден в использовании.Учитывая сборку и XML, сгенерированный Visual Studio, document может создать весь веб-сайт документации с помощью одной команды.

---

Третий параметр - NDoc :

NDoc генерирует документацию библиотеки классов из сборок .NET и файлов документации XML, созданных компилятором C # (или с помощью дополнительного инструмента для VB.NET).

NDoc использует подключаемый модульДокументаторы для создания документации в нескольких различных форматах, включая формат справки HTML в стиле MSDN (.chm), формат справки Visual Studio .NET (справка HTML 2) и веб-страницы в стиле MSDN.

Answer 2

Оформить Конструктор файлов справки Sandcastle . Это инструмент с графическим интерфейсом, с которым довольно легко работать с Sandcastle. Он будет установлен в папку в меню «Пуск» -> «Program Files» -> «Sandcastle Help File Builder»; Он довольно прост в использовании, но не невероятно быстр.

Надеюсь, это поможет!

Answer 3

Я создал проект с открытым исходным кодом, чтобы отобразить их на веб-страницах. Проверка @ AutoHelp

AutoHelp считывает файлы DLL и XML Doc, генерирует страницы справки и предоставляет их дляпользователи.AutoHelp в качестве современного веб-приложения использует ASP.NET MVC 5, ASP.NET WebApi, TypeScript, jQuery и Bootstrap.

Answer 4

NDoc также является опцией.Но я бы пошел с замком из песка, и это было то, что я сделал.