mdoc – Online in der Cloud

PROGRAMM:

NAME/FUNKTION

mdoc – Mono-Dokumentationsverwaltungstool

ZUSAMMENFASSUNG

mdoc Befehl [Optionen] [args]

Überblick

mdoc ist ein baugruppenbasiertes Dokumentationsmanagementsystem.

mdoc ermöglicht die Erstellung und Aktualisierung von Dokumentationen Stummel basierend auf dem Inhalt eines
Montage. Es ist nicht auf die im Quellcode enthaltene Dokumentation angewiesen.

Die Vorteile sind:

* Code Lesbarkeit. Eine gute Dokumentation ist häufig (a) ausführlich und (b) ausgefüllt
mit Beispielen. (Zum Vergleich siehe Dokumentation zum Microsoft .NET Framework,
Dies ist oft eine oder mehrere Seiten mit Dokumenten für jedes Mitglied, bis hin zur JavaDoc-Dokumentation.
was oft ein Satz für jedes Mitglied sein kann.)

Das Einfügen einer guten Dokumentation in den Quellcode kann die Quelle häufig aufblähen
Datei, da die Dokumentation länger sein kann als die eigentliche Methode
Dokumentiert.

* Lokalisierung In-Source-Dokumentationsformate (z. B csc /doc) haben keine Unterstützung
für mehrere menschliche Sprachen. Wenn Sie mehr als eine menschliche Sprache unterstützen müssen
zu Dokumentationszwecken, mdoc ist nützlich, da es die Ausgabe jeder Sprache ermöglicht
sich in einem eigenen Verzeichnis befinden und mdoc kann Typen/Mitglieder für jeden einzelnen hinzufügen
Dokumentationsverzeichnis.

* Verwaltung. Es ist nicht ungewöhnlich, dass Dokumentation und Entwicklung getrennt sind
Mannschaften. Es ist auch möglich, dass das Dokumentationsteam nur über minimale Erfahrung verfügt
mit der verwendeten Programmiersprache. Unter solchen Umständen inline
Dokumentation ist nicht wünschenswert, da das Dokumentationsteam versehentlich einfügen könnte
Beim Aktualisieren der Dokumentation ist ein Fehler im Quellcode aufgetreten. Alternativ Sie
Möglicherweise möchte das Dokumentationsteam aus Sicherheitsgründen keinen Zugriff auf den Quellcode haben
Gründe dafür. mdoc ermöglicht die Aufbewahrung der Dokumentation uneingeschränkt getrennt und verschieden
aus dem Quellcode, der zum Erstellen der Assembly verwendet wurde.

Mit dem kann eine Dokumentation erstellt werden mdoc Aktualisierung Befehl:

mdoc update -o docs/en Projektname.dll

Sobald die Dokumentations-Stubs erstellt (und hoffentlich später ausgefüllt) wurden
tatsächliche Dokumentation), gibt es drei Möglichkeiten, die Dokumentation anzuzeigen:

* Um ein einfaches Verzeichnis von HTML-Seiten zu generieren (eine HTML-Datei pro Typ), verwenden Sie mdoc
export-html:

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

* Informationen zur Verwendung einer ASP.NET-Webanwendung zum Anzeigen der Quellen finden Sie unter: http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.

Von einem Monodoc Wenn Sie die Quelle auschecken, können Sie Folgendes tun:

CD-Engine
Web machen

Dies wird verwendet xsp(1) um die ASP.NET-Webanwendung bereitzustellen; Besuchen http://localhost: 8080 / zu
Sehen Sie sich die Dokumentation an.

* So verwenden Sie die Monodoc(1) Dokumentationsbrowser, Sie müssen zuerst montieren
Dokumentation:

mdocassemble -o Projektname docs/en

Der obige Befehl erstellt die Dateien Projektname.baum und Projektname.zipEine
zusätzlich Projektname.sources Es muss eine Datei bereitgestellt werden, die beschreibt, wo in der
Hilfesystem, die Dokumentation soll angebunden werden; es ist eine sehr einfache XML-Datei,
so was:

<? Xml version = "1.0"?>

<Quelle Provider="ecma" basefile="Projektname"
path="verschiedene" />


Die obige Konfigurationsdatei beschreibt, dass die Dokumentation im ECMA-Format vorliegt.
dass der Basisdateiname lautet Projektname und dass es angeschlossen werden sollte
"verschieden" Teil des Dokumentationsbaums. Wenn Sie sich die verschiedenen Knoten ansehen möchten
In der Dokumentation definiert, können Sie sich die ansehen monodoc.xml Datei, die ist
typischerweise installiert in /usr/lib/monodoc/monodoc.xml.

Sobald Sie alle erforderlichen Dateien (.zip, .tree und .sources) haben, können Sie mit der Installation beginnen
Fügen Sie sie mit dem folgenden Befehl in das System ein:

cp Projektname.tree Projektname.zip Projektname.source \
`pkg-config monodoc --variable resourcesdir`

Dadurch werden die Dateien in das Verzeichnis kopiert, das Monodoc registriert hat. Du
Möglicherweise sind hierfür Root-Berechtigungen erforderlich. Das tatsächliche Verzeichnis wird von zurückgegeben
pkg-config Aufruf.

MDOC BEFEHLE

mdoc montieren
Stellt Dokumentation zur Verwendung innerhalb der zusammen Monodoc(1) Browser.

Weitere Informationen im mdoc-assemble(1) Manpage für Details.

mdoc export-html
Exportiert die Dokumentation in eine Verzeichnisstruktur von HTML-Dateien.

Weitere Informationen im mdoc-export-html(1) Manpage für Details.

mdoc export-msxdoc
Exportiert die Dokumentation in die Einzeldatei Microsoft XML Dokumentation Format.

Weitere Informationen im mdoc-export-msxdoc(1) Manpage für Details.

mdoc Hilfe
Interne Hilfe für einen bestimmten Befehl anzeigen.

mdoc hilft beim Zusammenbau

ist äquivalent zu:

mdocassemble --help

Es können mehrere Unterbefehle gleichzeitig aufgeführt werden:

mdoc hilft bei der Zusammenstellung des Export-HTML-Updates und validiert es

mdoc Aktualisierung
Aktualisiert die Dokumentation und fügt Mitglieder basierend auf einer Referenzbaugruppe hinzu und entfernt sie.

Weitere Informationen im mdoc-update(1) Manpage für Details.

mdoc bestätigen
Validiert die Dokumentation anhand des Mono-Dokumentationsschemas.

Weitere Informationen im mdoc-validieren(1) Manpage für Details.

Verwenden Sie mdoc online über die Dienste von onworks.net