Подтвердить что ты не робот

Что я могу сделать с моей XML-документацией?

Я просто открываю, что я могу создать документацию XML для своего проекта с VisualStudio 2010 с тегами "///" в коде. Это кажется волшебным, но что я могу сделать с этим? Существует ли какое-то приложение, которое может сделать меня "красивым документом" с XML файлом? Или преобразовать его в HTML-документ?

Спасибо за ответы!

4b9b3361

Ответ 1

Существует несколько приложений, которые могут принимать ваши комментарии XML и создавать документы API стиля MSDN для вас (работая в списке):

Sandcastle (Microsoft)
NDoc
Live Documenter

Ответ 2

Другое приложение: VSdocman

Ответ 3

Я использую GhostDoc, чтобы помочь сгенерировать комментарии XML-документа, и Sandcastle с Sandcastle Help File Builder, чтобы превратить это в скомпилированный файл справки, который похож на документацию MSDN.

Подробное руководство по использованию Sandcastle/Sandcastle Help File Builder можно найти здесь.

Я также пробовал Doxygen и нашел, что он довольно прост в использовании, но предпочитал внешний вид документации, которую производил Sandcastle.

Ответ 4

Есть альтернативный инструмент DocFX, разработанный Microsoft.

Он генерирует API-документ в формате HTML, например this.