Создание документации из XML-комментариев С#

Ответ 1

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

Doxygen генерирует документацию по стилю javadoc, хотя похоже, что он в основном предназначен для создания документации из пользовательской разметки в ваших комментариях. Очевидно, Doxygen также поддерживает комментарии на С# XML, хотя я не могу найти их упоминания на их веб-сайте!

В любом случае, я рекомендую. Он прост в использовании, поддерживает несколько языков, а также создает диаграммы классов для вас.

Ответ 2

вы можете использовать sandcastle для этого.

некоторые ресурсы на нем: Сандкасло:

• Sandcastle
• Конструктор файлов подсказок Sandcastle - графический интерфейс пользователя
• DocProject для Sandcastle

Статьи о документировании кода С#:

• XML-комментарии Позволяют строить документацию напрямую из исходных файлов Visual Studio.NET (в журнале MSDN)
• Документация и комментарий к С# (в CodeProject)
• Документация исходного кода на С# и XML (в CodeProject)
• Учебное пособие по С# Урок 19: Документация по кодексу

Ответ 3

Могу ли я смиренно предложить попробовать ImmDoc.NET - простой проект, который я разработал некоторое время назад и недавно опубликовал на CodePlex. Он легкий, очень прост в использовании и поддерживает .NET 2.0.

Ответ 4

@Portman: NDoc мертв, а Sandcastle может быть лучшим (чтобы быть мертвым) Doxygen настолько прост в использовании прямо из коробки, он также очень настраивается.

Он также имеет графический интерфейс, который помогает с настройкой и тестированием, чтобы вы могли настроить содержимое своих сердец.

Ответ 5

Я рад, что вы нашли лучшую альтернативу - Doxygen! Я использую Doxygen для С#.NET, и он генерирует диаграммы классов, диаграммы наследования и т.д. Вот информативный пост .

Ответ 6

Благодаря ответу @zappan, который помогает мне, я собираюсь упростить для каждого, кто хочет создать .Net-документацию. Я использую этот документ в качестве ссылки:

Прежде всего, вы должны включить "создать файл документации XML для Visual Studio" (Visual studio не создает этот файл по умолчанию):

Щелкните правой кнопкой мыши по проекту и выберите Properties, которые вызывают окно свойств. Выберите вкладку Build и, наконец, включите XML documentation file. Убедитесь, что на этом этапе вы Строят свой проект.

Во-вторых, загрузите File Builder в стиле Sandcastle, который поможет легко создать API-интерфейс документа, предоставив графический интерфейс. Обратите внимание, что он содержит установочный файл Sandcastle, поэтому вам не нужна загрузка Sandcastle.

Теперь создать документацию легко:

1- Откройте "Файл" Builder и создайте новый проект.

2- В Project Explorer щелкните правой кнопкой мыши по Documentation Source и выберите Add Documentation Source.

3 Перейдите в папку, в которой находится файл сборки dll и файл документации XML (обычно в папке bin/debug). Выберите файл сборки и xml и нажмите кнопку Open.

4- В меню Documentation выберите Build Project.

После этого шага помощь находится в вашем проекте корневой папки Sandcastle и в папке справки.

Ответ 7

Live Documenter - это инструмент документации по комментариям .NET. Работает для всех версий .NET и, кажется, поддерживает все новые функции.

Ответ 8

Не могу поверить, что прошло 11 часов, и никто не упомянул NDoc, что точно что вы ищете.

Ответ 9

Я использую этот, только потому, что Sandcastle пока не был готов, когда мне это нужно: CodeDoc

Изменить - я использовал Internet Explorer на этой задаче, просто понял, что сайт не работает в firefox:(