НДок
 NDoc 1.3.1 отображает пустой проект | |
| Разработчик(и) | Даймонд, Маноли и др. |
|---|---|
| Стабильная версия | 1.3.1
/ 25 января 2005 г. |
| Операционная система | Кроссплатформенный (?) |
| Тип | Генератор документации |
| Лицензия | GNU GPL |
| Веб-сайт | следовать |
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. Хотя есть внутренние альфа-версии [1] [2] поддерживающие .NET 2.0 по состоянию на 2006 г. [update], в проекте NDoc очень мало активности. Разработчик NDoc Кевин Даунс заявил, что больше не работает над NDoc из-за отсутствия финансирования и угроз в его адрес и готов передать управление проектом. [3] Совсем недавно Ким Кристенсен взял мяч в свои руки и продолжил разработку оригинального NDoc под названием NDoc3. [4]
См. также
[ редактировать ]
- Doxygen — зрелый инструмент для создания документов, который также может создавать диаграммы классов и создавать документацию на многих других языках.
- Sandcastle — аналогичное приложение от Microsoft .
- Sandcastle Help File Builder — бесплатный интерфейс с графическим интерфейсом для Sandcastle, предоставляющий функции, подобные Ndoc.
- Visual Expert — генератор документации , который также предоставляет деревья вызовов , матрицу CRUD , анализ воздействия , обзор кода для PL/SQL , Transact-SQL и других языков.
- Сравнение генераторов документации