NDoc - NDoc
 NDoc 1.3.1 отображает пустой проект
| |
| Разработчики) | Даймонд, Маноли и др. |
|---|---|
| Стабильный выпуск | 1.3.1 / 25 января 2005 г. |
| Операционная система | Кросс-платформенный (?) |
| Тип | Генератор документации |
| Лицензия | GNU GPL |
| Интернет сайт | ndoc |
NDoc - это генератор документации кода для Common Language Infrastructure, созданный Джейсоном Даймондом, Жан-Клодом Маноли и Кралом Ферчем. Он находится под лицензией GNU General Public License .
Как это устроено
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 - бесплатный графический интерфейс для Sandcastle, который предоставляет функции, подобные Ndoc.
- Visual Expert - генератор документации, который также предоставляет деревья вызовов , матрицу CRUD , анализ воздействия , обзор кода для PL / SQL , Transact-SQL и других языков.
- Сравнение генераторов документации