mdoc - Интернет в облаке

ПРОГРАММА:

ИМЯ

mdoc - инструмент управления документацией Mono

СИНТАКСИС

mdoc команду [кредита] [арг]

ОБЪЯВЛЕНИЕ

mdoc это система управления документацией на основе сборки.

mdoc позволяет создавать и обновлять документацию заглушки на основе содержания
сборка. Он не полагается на документацию, содержащуюся в исходном коде.

Преимущества:

* Code читаемость. Хорошая документация часто (а) многословна и (б) заполнена
с примерами. (Для сравнения сравните документацию Microsoft .NET Framework,
который часто представляет собой страницу или несколько документов для каждого члена, в документацию JavaDoc,
что часто может быть приговором для каждого участника.)

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

* Локализация. Форматы документации в исходном коде (например, косеканс / документ) не имеют поддержки
для нескольких человеческих языков. Если вам нужно поддерживать более одного человеческого языка
для документации, mdoc полезен, поскольку он позволяет выводить на каждом языке
находятся в собственном каталоге и mdoc может добавлять типы / члены для каждого отдельного
каталог документации.

* Администрация. Нет ничего необычного в том, чтобы иметь отдельную документацию и разработку
команды. Также возможно, что команда документации будет иметь минимальный опыт
с используемым языком программирования. В таких обстоятельствах встроенный
документация нежелательна, так как команда документации может случайно вставить
ошибка в исходном коде при обновлении документации. В качестве альтернативы вы
может не захотеть, чтобы команда разработчиков документации имела доступ к исходному коду в целях безопасности
причины. mdoc позволяет хранить документацию полностью отдельный и отличный
из исходного кода, использованного для создания сборки.

Документацию можно создать с помощью mdoc обновление команда:

mdoc update -o docs / en ProjectName.dll

Как только заготовки документации будут созданы (и, надеюсь, позже будут заполнены
фактическую документацию), есть три способа просмотреть документацию:

* Чтобы создать простой каталог HTML-страниц (по одному HTML-файлу каждого типа), используйте mdoc
экспорт-HTML:

mdoc export-html -o / srv / www / htdocs / ProjectName docs / en

* Чтобы использовать веб-приложение ASP.NET для отображения источников, см. http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.

Из монодок исходный код, вы можете сделать это:

cd двигатель
сделать сеть

Это будет использовать хсп(1) для обслуживания веб-приложения ASP.NET; Визит http://localhost: 8080 / в
просмотреть документацию.

* Для использования монодок(1) браузер документации, вы должны сначала собираться домен
документация:

mdoc assembly -o ProjectName docs / en

Приведенная выше команда создает файлы ИмяПроекта.дерево и ИмяПроекта.zip.
дополнительный ИмяПроекта.источники должен быть предоставлен файл, который описывает, где в
справочная система должна быть подключена документация; это очень простой XML-файл,
как это:

<? XML-версия = "1.0">

<sourceProvider="ecma" basefile="ИмяПроекта"
путь = "различные" />


Приведенный выше файл конфигурации описывает, что документация находится в формате ECMA,
что базовое имя файла Название проекта и что он должен быть подключен к
"различный" часть дерева документации. Если вы хотите посмотреть на различные узлы
определено в документации, вы можете посмотреть монодок.xml файл, который
обычно устанавливается в /usr/lib/monodoc/monodoc.xml.

Когда у вас есть все необходимые файлы (.zip, .tree и .sources), вы можете установить
их в систему с помощью следующей команды:

cp ИмяПроекта.treeИмяПроекта.zipИмяПроекта.источник \
`pkg-config monodoc --variable sourcedir`

Вышеупомянутое скопирует файлы в каталог, зарегистрированный Monodoc; ты
для этого могут потребоваться права root. Фактический каталог возвращается
pkg-конфигурация призыв.

МДОК КОМАНДЫ

mdoc собираться
Компилирует документацию для использования в монодок(1) браузер.

Смотрите пост в mdoc-assembly(1) справочная страница для получения подробной информации.

mdoc экспорт-HTML
Экспортирует документацию в структуру каталогов файлов HTML.

Смотрите пост в mdoc-экспорт-html(1) справочная страница для получения подробной информации.

mdoc экспорт-msxdoc
Экспортирует документацию в однофайловый Microsoft XML Документация формат.

Смотрите пост в mdoc-экспорт-msxdoc(1) справочная страница для получения подробной информации.

mdoc помощь
Просмотр внутренней справки по заданной команде.

mdoc помогите собрать

эквивалентно:

mdoc assembly --help

Одновременно может быть указано несколько подкоманд:

mdoc поможет собрать проверку обновлений export-html

mdoc обновление
Обновляет документацию, добавляя и удаляя элементы на основе эталонной сборки.

Смотрите пост в mdoc-обновление(1) справочная страница для получения подробной информации.

mdoc подтверждать
Проверяет документацию на соответствие схеме документации Mono.

Смотрите пост в mdoc-проверить(1) справочная страница для получения подробной информации.

Используйте mdoc онлайн с помощью сервисов onworks.net