WikiDer > Естественные документы
 | Эта статья поднимает множество проблем. Пожалуйста помоги Улучши это или обсудите эти вопросы на страница обсуждения. (Узнайте, как и когда удалить эти сообщения-шаблоны) (Узнайте, как и когда удалить этот шаблон сообщения)
|
 | |
| Оригинальный автор (ы) | Грег Валюр |
|---|---|
| Стабильный выпуск | 2.0.2 / 15 мая 2018 г. |
| Репозиторий |  |
| Написано в | C # (Perl до 2.0)[1] |
| Операционная система | Кроссплатформенность |
| Тип | Генератор документации |
| Лицензия | Стандартная общественная лицензия Affero |
| Интернет сайт | NaturalDocs.org |
Естественные документы многоязычный генератор документации. Это написано в C # и доступен как бесплатно программное обеспечение в соответствии с условиями Стандартная общественная лицензия Affero. Он пытается сохранить комментарии, написанные на исходный код так же легко читается, как и созданная документация. Он написан и поддерживается Грегом Валюром.
Фон
Теоретически Natural Docs может создавать документацию на любом языке, поддерживающем комментарии, или из простых текстовых файлов. При выполнении он может автоматически документировать функции, переменные, классы и наследование от ActionScript, C #, и Perl независимо от существующей документации в исходном коде. На всех других языках они должны быть явно задокументированы для их создания. Он может создавать документацию в HTML, с рамкой или без.
В отличие от Javadoc, он не считается отраслевым стандартом для документации на каком-либо языке, хотя может включать документацию Javadoc для языков с «полной поддержкой».[2] Его используют некоторые любители и компании, такие как CNET Networks, Inc. и Iron Realms Развлечения.[3][4] Он завоевал популярность среди ActionScript разработчиков, потому что не существует другого бесплатного генератора документации, который полностью поддерживает ActionScript, и потому что он генерирует более качественный вывод, чем аналогичные генераторы, частично поддерживающие язык, например ROBODoc.
Пример
Это пример стиля документации:
/* * Функция: умножение * * Умножает два целых числа. * * Параметры: * x - первое целое число. * y - второе целое число. * * Возврат: * Два целых числа, умноженные вместе. * * Смотрите также: * Для сравнения, вот как то же самое можно было бы задокументировать с Javadoc:
/** * Умножает два целых числа. * * @param x Первое целое число. * @param y Второе целое число. * @return Два целых числа, умноженные вместе. * @see Divide */ int Умножить (int Икс, int у) { возвращаться Икс * у; }Смотрите также
Примечания и ссылки
- ^ О Natural Docs
- ^ Естественные языки документов
- ^ Глобальная структура CNET к CNET Networks, Inc. и созданная документация используя Natural Docs
- ^ Восторг к Iron Realms Развлечения и созданная документация используя Natural Docs