Mkd (Kommandozeile)
mkd ist ein Unix-Kommando zum Abrufen codierter Kommentare und zum Generieren von Software-Dokumentationen. mkd ist eine Abkürzung von make documentation (Englische Wörter Bedeutung : « dokumentiere »). Diese Befehl war früher bekannt als mkdoc (make documentation).
Dieser Befehl ist nicht in UNIX- / LINUX-Distributionen integriert.
Inhaltsverzeichnis
[Verbergen]Kommandozeile Syntax[Bearbeiten]
Kommandozeile in Terminal oder in Konsole :
- nadine@Ordinateur-de-nadine-linux:~$ mkd
zeigt die Syntax :
Syntax: mkd [-ABCFPSafjlnpstvw] Codes Quellpfad [Zieldatei]
oder:mkd \? .Siehe auch im Handbuch 'man mkd'
- nadine@Ordinateur-de-nadine-linux:~$ mkd \?
zeigt die Syntax :
mkd UNIX Version, Update 12.03, GEBRAUCH:
Syntax: mkd [-ABCFPSafjlnpstvw] Codes Quellpfad [Zieldatei]
oder:mkd \? .Siehe auch im Handbuch 'man mkd'
--> Optionen:
-A Stil Assembler (Dekodiert nur Kommentare in Assembler Stil)
-B Stil Basic
-C Stil C, C++, php
-F Stil Fortran
-P Stil Pascal
-S Stil Shell
-a fügt die Zieldatei
-f:
sucht Programmiersprache ( .s .S .c .h .i .f .F .r .p .sh .csh )
-j Benutzen Sie nur mit Quellen-Projekt-Datei.
-l und -p; Zeile: (Kompilation Optionen: von: % oder - in der ersten Spalte oder # in der Zeile)
Seite: (Kompilation Optionnen: Beginnen mit " und endet mit ")
-n Zeilennummer einfügen
-s Kopiert in der Zieldatei und in Bildschirm
-t kopiert nur den Kommentar
-v Spricht viel (verbose)
-w Überschreiben Zieldatei (Standardoption)
--> Codes: alle ASCII (5 Zeichen max)
Beispiel Codes = UM, oder \*OPTw, oder '* HOS', oder '**' für alle
--> Quellpfad: Quelldatei (Option j: nur mit Quellen-Projekt-Datei
--> Zieldateipfad: Zieldatei
Beispiel: mkd -Csnv '*S' file.c \*.Audit-Struktur
.Return-code 2
Beispiel für die Anwendung[Bearbeiten]
Wenn möglich, schrieben sie jede Funktion eines Programm in einer separate Datei.
Wenn die Funktionen in einer einzigen Datei gruppiert werden, wird die Dokumentation der Funktionen in der gleichen Reihenfolge wie in der Quelldatei angezeigt.
Die Funktion Datei gibt die Syntax (Header) und seine Verwendung
Beispiel für die cpp_ Funkion : in cpp_.c Datei.
/*D
fonction cpp_
-----------------------------------------------------------------------------
ACTION:
La fonction cpp_ lit le fichier source (pnfile) qui est transmis en
paramètre et décode les lignes de commentaires précodés dans le style C++
puis les transcrit dans le fichier de destination (pfdoc) lorsque le code
correspond à un des codes externes à la fonction;
Les variables globales sont les codes et les options.
Les codes, tabeau de 5 caractères:
extern char codes[];
ils doivent être définis dans le programme d'appel:
char codes[5] = {0,0,0,0,0};
Les options, n,s,t,v.
extern unsigned char n,s,t,v;
elles doivent définies dans le programme d'appel:
unsigned char n=0,s=0,t=0,v=0;
Avec les options :
n: La transcription est précédée du numéro de ligne. Ceci permet
d'atteindre facilement la ligne commentée.
t: Avec l'option t seul le texte commenté est recopié.
Sans l'option t le commentaire est entièrement recopié.
Cette option t permet donc de générer des documents directement
exploitables ou publiables.
s: ajoute le commentaire à l'écran.
v: mode bavard
Remarque :
Si la dédection d'un commentare à transcrire commence par le caractère '/'
suivi de '*' il sera transcrit jusqu'à rencontrer le caractère '*' suivi
de '/', quel que soit le commentaire ligne inclus dans ce commentaire.
Si la détection d'un commentaire commence par deux caractères '/', le
commentaire sera copié jusqu'au prochain retour à la ligne (NL) ou fin de
fichier (EOF).
Ces dispositions facilitent la génération automatique des fichiers
d'entête fichier.h ou .hpp etc.
SYNTAXE:
#include "version.h"
#include "cpp_.h"
int cpp_(FILE *pfdoc, FILE *pnfile);
PORTABILITE:
Microsoft Visual studio sous Windows : x86(Win32) x64(Win32 et WIN64)
gcc sous Linux.
DESCRIPTION:
cpp_ fonction
FILE* pfdoc: pointeur sur le fichier de destination ouvert par le
programme appelant.
FILE* pnfile: pointeur sur le fichier source ouvert par le programme
appelant
VALEUR RETOURNEE:
Retourne 0 en cas de succès.
DROIT DE COPIE: (précisé dans version.h) :
*/
/*H
// cpp_.c:
extern int cpp_ (FILE *pfdoc, FILE *pnfile);
*/
Alle Pfade in der Anwendung sind in einer Datei Zielprojekt in alphabetischer Reihenfolge aufgeführt.
- Beispiel : "ls -1 *.c > app.prj" Enthält den Pfad aller Dateien zu lesen, um die Softwaredokumentation zu generieren.
Aufmerksamkeit, ls -1 (Ziffer Eins) und nicht -l (Buchstabe 'l')'
Die Befehlszeile "mkd -Cjt H app.prj app.h" generiert die Datei mit allen aller Funktionen-Header.
Die Befehlszeile "mkd -Cjt D app.prj app_Funktionen.Dokumentation " generiert die Datei für die Dokumentation aller Funktionen.
Handbuchseite[Bearbeiten]
Alle Übersetzungen des Handbuchs (Siehe Externe Weblinks)
Betriebssysteme[Bearbeiten]
Debian und Ubuntu[Bearbeiten]
Die Pakete sind versichert für Ubuntu (und Debian) : mkd Pakete und Externe links
Fedora und Red Hat[Bearbeiten]
Diese Anwendung wurde mit verwendet : Red Hat, SUN-Sparc, HP-UX bis zum Jahr 2000 im Format ASCII, und danach in ISO 8859-1.
mkd ist kompilierbare als ist für Fedora. (In UTF-8-format)
Die RPM-Pakete werden nicht von Maintainers verteilt.
Andere Linux-Distributionen[Bearbeiten]
Viele Linux-Distributionen sind verfügbar. mkd ist, normalerweise, kompatibel mit allen Linux- und Unix-Systemen, manchmal gibt es Unterschiede in den Dokumentation Pfaden.
DOS/Windows[Bearbeiten]
mkd für MS-Windows verwendete Befehlszeile in einem 'cmd' Windows-basierten terminal.
Siehe auch[Bearbeiten]
Wikibooks: fr:Mkd_(Extracteur_de_documents)/Internationalisation_des_manuels/mkd-Handbuch – Lern- und LehrmaterialienWeblinks[Bearbeiten]
- Le projet mkd Präsentation des Projekt mkd und seine Derivate mkd* auf der Maintainers Webseite.
- Downloads für debian und Ubuntu Software-Bibliothek und alle Übersetzungen des Handbuchs.
Verfügbarkeit der Quellen : Sources für andere Systeme (UNIX, LINUX, WINDOWS)
