mdoc - Online sa Cloud

PROGRAMA:

NAME

mdoc - Mono documentation management tool

SINOPSIS

mdoc utos [pagpipilian] [mga pagtatalo]

PANGKALAHATANG-IDEYA

mdoc ay isang assembly-based na sistema ng pamamahala ng dokumentasyon.

mdoc pinahihintulutan ang paglikha at pag-update ng dokumentasyon stubs batay sa nilalaman ng isang
pagpupulong. Hindi ito umaasa sa dokumentasyong makikita sa loob ng source code.

Ang mga kalamangan ay:

* kodigo kakayahang mabasa. Ang mahusay na dokumentasyon ay madalas na (a) verbose, at (b) napuno
na may mga halimbawa. (Para sa paghahambing, ihambing ang dokumentasyon ng Microsoft .NET Framework,
na kadalasang isang pahina o higit pa sa mga doc para sa bawat miyembro, sa dokumentasyon ng JavaDoc,
na kadalasang maaaring isang pangungusap para sa bawat miyembro.)

Ang pagpasok ng magandang dokumentasyon sa source code ay maaaring madalas na mabulok ang pinagmulan
file, dahil maaaring mas mahaba ang dokumentasyon kaysa sa aktwal na paraan na ginagawa
dokumentado.

* Lokalisasyon. In-source na mga format ng dokumentasyon (tulad ng csc /doc) walang suporta
para sa maraming wika ng tao. Kung kailangan mong suportahan ang higit sa isang wika ng tao
para sa mga layunin ng dokumentasyon, mdoc ay kapaki-pakinabang dahil pinapayagan nito ang output ng bawat wika sa
naninirahan sa sarili nitong direktoryo, at mdoc maaaring magdagdag ng mga uri/miyembro para sa bawat hiwalay
direktoryo ng dokumentasyon.

* Pangangasiwa. Hindi karaniwan na magkaroon ng hiwalay na dokumentasyon at pag-unlad
mga koponan. Posible rin na ang pangkat ng dokumentasyon ay magkakaroon ng kaunting karanasan
gamit ang programming language na ginagamit. Sa ganitong mga pangyayari, inline
hindi kanais-nais ang dokumentasyon dahil maaaring hindi sinasadyang maipasok ng pangkat ng dokumentasyon
isang error sa source code habang ina-update ang dokumentasyon. Bilang kahalili, ikaw
Maaaring hindi gusto ng pangkat ng dokumentasyon na magkaroon ng access sa source code para sa seguridad
mga dahilan. mdoc nagbibigay-daan sa pag-iingat ng dokumentasyon ganap magkahiwalay at magkakaiba
mula sa source code na ginamit sa paggawa ng assembly.

Maaaring makabuo ng dokumentasyon gamit ang mdoc update utos:

mdoc update -o docs/en ProjectName.dll

Kapag nabuo na ang mga stub ng dokumentasyon (at sana ay mapunan sa ibang pagkakataon ng
aktwal na dokumentasyon), mayroong tatlong paraan upang tingnan ang dokumentasyon:

* Upang bumuo ng isang simpleng direktoryo ng mga pahina ng HTML (isang HTML file bawat uri), gamitin mdoc
export-html:

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

* Para gumamit ng ASP.NET webapp para ipakita ang mga source, tingnan ang: http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.

Mula sa isang monodoc source checkout, magagawa mo ito:

cd engine
gumawa ng web

Ito ang gagamitin xsp(1) upang ihatid ang ASP.NET webapp; Bisitahin http://localhost: 8080 / sa
tingnan ang dokumentasyon.

* Upang magamit ang monodoc(1) documentation browser, kailangan mo muna magtipon ang
dokumentasyon:

mdoc assemble -o ProjectName docs/en

Ang utos sa itaas ay lumilikha ng mga file ProjectName.tree at ProjectName.zip, Sa
karagdagan ProjectName.sources file ay dapat ibigay na naglalarawan kung saan sa
sistema ng tulong ang dokumentasyon ay dapat na naka-hook up; ito ay isang napakasimpleng XML file,
ganito:



<source provider="ecma" basefile="ProjectName"
landas="iba't ibang" />


Ang configuration file sa itaas ay naglalarawan na ang dokumentasyon ay nasa ECMA na format,
na ang batayang pangalan ng file ay Pangalan ng proyekto at dapat itong ikabit sa
"iba-iba" bahagi ng puno ng dokumentasyon. Kung nais mong tingnan ang iba't ibang mga node
tinukoy sa dokumentasyon, maaari mong tingnan ang monodoc.xml file which is
karaniwang naka-install sa /usr/lib/monodoc/monodoc.xml.

Kapag nakuha mo na ang lahat ng kinakailangang file (.zip, .tree at .sources) maaari mong i-install
sila sa system na may sumusunod na utos:

cp ProjectName.tree ProjectName.zip ProjectName.source \
`pkg-config monodoc --variable sourcesdir`

Kokopyahin ng nasa itaas ang mga file sa direktoryo na nairehistro ng Monodoc; ikaw
maaaring kailanganin ng mga pahintulot sa ugat para magawa ito. Ang aktwal na direktoryo ay ibinalik ng
pkg-config panawagan.

MDOC UTOS

mdoc magtipon
Nag-compile ng dokumentasyon para magamit sa loob ng monodoc(1) browser.

Tingnan ang mdoc-assemble(1) man page para sa mga detalye.

mdoc export-html
Ini-export ang dokumentasyon sa isang istraktura ng direktoryo ng mga HTML file.

Tingnan ang mdoc-export-html(1) man page para sa mga detalye.

mdoc export-msxdoc
Ini-export ang dokumentasyon sa solong file microsoft XML dokumentasyon format.

Tingnan ang mdoc-export-msxdoc(1) man page para sa mga detalye.

mdoc Tulungan
Tingnan ang panloob na tulong para sa isang ibinigay na utos.

tulong ng mdoc sa pag-assemble

ay katumbas ng:

mdoc assemble --help

Maaaring ilista ang maramihang mga sub-command nang sabay-sabay:

mdoc help assemble export-html update validate

mdoc update
Ina-update ang dokumentasyon, pagdaragdag at pag-alis ng mga miyembro batay sa isang reference assembly.

Tingnan ang mdoc-update(1) man page para sa mga detalye.

mdoc patunayan
Pinapatunayan ang dokumentasyon laban sa schema ng dokumentasyon ng Mono.

Tingnan ang mdoc-validate(1) man page para sa mga detalye.

Gamitin ang mdoc online gamit ang mga serbisyo ng onworks.net