NDoc

редактировать

NDoc
NDoc 1.3.1 отображает пустой проект
Разработчик (и)	Diamond, Manoli и др.

Стабильный выпуск	1.3.1 / 25 января 2005 г.

Операционная система	Кросс-платформенный (?)
Тип	Генератор документации
Лицензия	GNU GPL
Веб-сайт	ndoc.sourceforge.net

NDoc - это код генератор документации для Common Языковая инфраструктура создана Джейсоном Даймондом, Жан-Клодом Маноли и Кралом Ферчем. Он под лицензией Стандартной общественной лицензии GNU.

Содержание

1 Как это работает
2 Ограничения и будущее развитие
3 См. Также
4 Ссылки
5 Внешние ссылки

Как это работает

NDoc использует два источника для создания документации. Первый - это файл сборки, созданный путем компиляции исходного кода. Другой - это предварительно сгенерированный файл документации XML, обычно создаваемый анализом исходного кода на предмет специальных комментариев (компиляторы C # из .NET Framework и Mono поддерживают это с помощью аргумента командной строки «/ doc»).

Файл сборки запрашивается с использованием отражения для получения списка классов, методов и т. Д. XML-файл анализируется на предмет документации текст.

NDoc использует плагины для поддержки нескольких различных форматов вывода, включая CHM, Microsoft Help Viewer, MSDN веб-страницы в стиле. Неполные плагины также включены в качестве отправных точек для разработчиков, например, плагин LaTeX и веб-страницы в стиле Javadoc. NDoc поставляется с графическим пользовательским интерфейсом, упрощающим процесс создания.

Ограничения и будущее развитие

Последняя версия NDoc не поддерживает .NET Framework версии 2.0. Хотя существуют внутренние альфа-версии, которые поддерживают.NET 2.0, по состоянию на 2006 г. активность над проектом NDoc очень незначительна. Разработчик NDoc, Кевин Даунс, заявил, что больше не работает над NDoc из-за отсутствия финансирования и угроз в его адрес, и что он готов передать управление проектом. Совсем недавно Ким Кристенсен взял мяч в руки и продолжает разработку оригинального NDoc как NDoc3

См. Также

Портал бесплатного программного обеспечения с открытым исходным кодом

Doxygen - зрелый инструмент для создания документов, который может также создавать диаграммы классов и создавать документацию на многих других языках.
Sandcastle - аналогичное приложение от Microsoft.
Sandcastle Help File Builder - бесплатный интерфейс GUI для Sandcastle, который обеспечивает Функции, подобные Ndoc.
Visual Expert - генератор документации, который также предоставляет деревья вызовов, матрицу CRUD, анализ воздействия, обзор кода для PL / SQL, Transact-SQL и других языков.
Сравнение генераторов документации

Ссылки

Внешние ссылки