Il s'agit de la commande mdoc qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
mdoc - Outil de gestion de documentation mono
SYNOPSIS
mdoc commander [Options] [args]
APERÇU
mdoc est un système de gestion de la documentation basé sur l'assemblage.
mdoc permet de créer et de mettre à jour la documentation bouts sur la base du contenu d'un
Assemblée. Il ne repose pas sur la documentation trouvée dans le code source.
Les avantages sont:
* Code lisibilité. Une bonne documentation est souvent (a) verbeuse et (b) remplie
avec des exemples. (Pour comparaison, comparez la documentation Microsoft .NET Framework,
qui est souvent une page ou plus de docs pour chaque membre, à la documentation JavaDoc,
qui peut souvent être une phrase pour chaque membre.)
L'insertion d'une bonne documentation dans le code source peut fréquemment gonfler la source
fichier, car la documentation peut être plus longue que la méthode réelle qui est
documenté.
* Localisation Formats de documentation dans la source (tels que csc /doc) n'ont aucun soutien
pour plusieurs langues humaines. Si vous devez prendre en charge plusieurs langues humaines
à des fins de documentation, mdoc est utile car il permet à la sortie de chaque langue de
résider dans son propre répertoire, et mdoc peut ajouter des types/membres pour chaque
répertoire de documentation.
* Administration. Il n'est pas rare d'avoir une documentation et un développement séparés
équipes. Il est également possible que l'équipe de documentation ait une expérience minimale
avec le langage de programmation utilisé. Dans de telles circonstances, en ligne
la documentation n'est pas souhaitable car l'équipe de documentation pourrait insérer par inadvertance
une erreur dans le code source lors de la mise à jour de la documentation. Alternativement, vous
peut ne pas vouloir que l'équipe de documentation ait accès au code source pour la sécurité
les raisons. mdoc permet de conserver la documentation complètement séparé et distinct
à partir du code source utilisé pour créer l'assembly.
La documentation peut être générée à l'aide du mdoc Mise à jour commander:
mdoc update -o docs/en ProjectName.dll
Une fois que les talons de documentation ont été générés (et, espérons-le, remplis plus tard avec
documentation réelle), il existe trois façons d'afficher la documentation :
* Pour générer un simple répertoire de pages HTML (un fichier HTML par type), utilisez mdoc
exporter-html:
mdoc export-html -o /srv/www/htdocs/NomProjet docs/en
* Pour utiliser une application Web ASP.NET pour afficher les sources, consultez : http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.
De monodoc vérification des sources, vous pouvez faire ceci :
moteur cd
faire du web
Cela utilisera xp(1) pour servir l'application Web ASP.NET ; Visite http://localhost: 8080 / à
consulter la documentation.
* Pour utiliser la monodoc(1) navigateur de documentation, vous devez d'abord assembler le
Documentation:
mdoc assembler -o ProjectName docs/en
La commande ci-dessus crée les fichiers NomProjet.tree et NomProjet.zip. Un
supplémentaire NomProjet.sources doit être fourni qui décrit où dans le
système d'aide, la documentation doit être connectée ; c'est un fichier XML très simple,
comme ça:
<? Xml version = "1.0"?>
<source supplier="ecma" basefile="ProjectName"
chemin="divers" />
Le fichier de configuration ci-dessus décrit que la documentation est au format ECMA,
que le nom du fichier de base est Nom du projet et qu'il devrait être branché dans le
"divers" partie de l'arbre de documentation. Si vous voulez regarder les différents nœuds
défini dans la documentation, vous pouvez consulter le monodoc.xml fichier qui est
généralement installé dans /usr/lib/monodoc/monodoc.xml.
Une fois que vous avez tous les fichiers requis (.zip, .tree et .sources), vous pouvez installer
dans le système avec la commande suivante :
cp NomProjet.tree NomProjet.zip NomProjet.source \
`pkg-config monodoc --variable sourcesdir`
Ce qui précède copiera les fichiers dans le répertoire que Monodoc a enregistré ; tu
peut avoir besoin d'autorisations root pour ce faire. Le répertoire réel est renvoyé par le
pkg-config invocation.
MDOC COMMANDES
mdoc assembler
Compile la documentation à utiliser dans le monodoc(1) navigateur.
Voir le mdoc-assembler(1) page de manuel pour plus de détails.
mdoc exporter-html
Exporte la documentation dans une structure de répertoires de fichiers HTML.
Voir le mdoc-export-html(1) page de manuel pour plus de détails.
mdoc exporter-msxdoc
Exporte la documentation dans le fichier unique Microsoft XML Documentation le format.
Voir le mdoc-export-msxdoc(1) page de manuel pour plus de détails.
mdoc vous aider
Afficher l'aide interne pour une commande donnée.
mdoc aide à assembler
est équivalent à:
mdoc assembler --help
Plusieurs sous-commandes peuvent être répertoriées à la fois :
mdoc aide à assembler export-html mise à jour valider
mdoc Mise à jour
Met à jour la documentation, en ajoutant et en supprimant des membres en fonction d'un assembly de référence.
Voir le mdoc-mise à jour(1) page de manuel pour plus de détails.
mdoc valider
Valide la documentation par rapport au schéma de documentation Mono.
Voir le mdoc-valider(1) page de manuel pour plus de détails.
Utiliser mdoc en ligne à l'aide des services onworks.net
