Benutzer:J Clara/Sandkasten/Test Seit mkd
mkd ist ein Unix-Kommando für Abrufen von codierte Kommentare und Generieren Software Dokumentation. mkd ist eine Abkürzum von make documentation (Englische Wörter Bedeutung : « machen die Dokumentation »). Diese Befehl war, vorher, bekannt als mkdoc (make documentation).
Dieser Befehl ist nicht in der UNIX / LINUX Distributionen integriert.
Kommandozeile Syntax
Kommandozeile in Terminal oder in Konsole :
- nadine@Ordinateur-de-nadine-linux:~$ mkd
zeigt die Syntax :
syntax: mkd [-ABCFPSafjlnpstvw] char_codes path_source [path_target]
or: mkd \? .See also nanual: 'man mkd'
Beispiel für die Anwendung
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
MKD(1)
BEZEICHNUNG
mkd - make documentation. Extrakte codierten Informationen aus Quellen
Programm und Produkt spezifische Dokumentation.
ÜBERSICHT
mkd [-ABCFPSafjlnpstw] char_codes path_source [path_target]
BESCHREIBUNG
mkd
Selected comments (or alle comments) are extracted from programs
sources and product specific documentation to target file. Usual
target files are Organigrams, or Structure of programs, or com‐
ments for Programmers, Warnings and Tests points .... Coded
informations are respectively 'O', 'S', 'P', 'www', ant 'T' just
after the comment character.
Ausgewählte Kommentaren, (oder alle Kommentaren) werden von Prog-
gramme Quelle extrahiert und Produkt spezifische Dokumentation.
Üblichen Zieldateien sind Organigramme, Struktur der Programme,
Kommentare für Programmierer, Warnungen oder Testpunkte Komment-
tare ... Codierte Informationen sind jeweils 'O', 'S', 'P',
'www' und 'T', direkt hinter dem Kommentar.
char_codes
Alle ASCII. Der Kommentar werden extrahiert, wenn der Kommentar
beginnt mit diesem Zeichen.
path_source
Pfad der Quelldatei. (Oder Projektdatei : Option j).
path_target
Pfad der Zieldatei. In der Standardeinstellung Pfad Ziel ist
identisch mit der Quelldatei mit der Erweiterung '.doc'.
OPTIONEN
Großbuchstaben Optionen:
Wählen Sie eine bestimmte Programmierung Sprache:
-A Assembler Stil Kommentare zu extrahieren ( ; Zum Ende der Zeile )
-B Basic Stil (REM or ' -> Ende der Zeile)
-C C Stil ( / * -> * / )
-F Fortran Stil (c,C or * -> Ende der Zeile)
-P Pascal Stil ( { -> } )
-S Shell oder Ratfor Stil ( # -> Ende der Zeile)
Kleinbuchstaben Optionen:
-a Hinzufügen am ende von Zieldatei.
-f Finden Quelldatei Programmierung Sprache. (Mit Projekt Datei)
-j Verwendet, wenn die Quelldatei ist eine Projektdatei.
-l Linien (Extrakt Linien beginnend mit CD1 oder CD2 in erste
Spalte, oder CD3 in Linie bis nächste ende der Zeile. CD1, CD2, CD3, sind
kompilierbare im Vertrieb und sind definiert in 'version.h')
-n Zeilennummerierung
-p Seite (Extrakt Text beschränkt mit CD4 und CD5 - Beginnend mit
CD4 und beendet mit CD5 - CD4, CD5, sind kompilierbare im Vertrieb
und sind definiert in 'mkd distribution', in 'version.h')
-s Fügt auf dem Konsole Bildschirm ('Verbose' ; Ausführliche)
-t Text (Kopiert nur der Kommentar).
-w Überschrieben die aktuelle Zieldatei.
BEISPIELE
Mit Cshell-Befehl:
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
Produkt französisch UNIX Manual.
mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
Produkt englisch UNIX Manual.
mkd -Csl '*Sied' mkd3.c '*.verif_struct'
Produkt Dokumentation mit Struktur der Programme, '#includes',
'#defines', '#ifdef', '#else' und '#endif' Kompilierte Optionen,
für überprüfen die Struktur in Quelldatei in Programms (Mit den
Kompilierung--optionen CD1='#' oder CD2='#' in 'mkd distribution'
version.h).
mkd -jfsl '*OHie' mkd_docu.prj mkd.org
Produkt Organigramm. Der Kommentar beginnt mit *,O,H, und Pfad
zu den Quelldatei sind die Komponenten der Projektdatei.
Optionen : 'f' finden der Stil der Sprache, 'j' sagte dass die
Quelldatei ist eine Projektdatei. (Mit den Kompilierung Optionen
CD1='#' oder CD2='#' in 'mkd distribution' version.h)
mkd -l '*ide' mkd3.c '*.id_ei'
( Mit Kompilierung--optionen CD1='#' oder CD2='#' extrahiert
#include, #define, #ifdef, #else, #endif Kompilierung--optionen
der C- Sprache.
mkd -pj '**' mkd_docu.prj mkd.strings
(Mit Kompilierung--optionen CD4=CD5='\"', extrahiert Saiten aus
aus den Quelldateien. (Die Saiten werden auf die Standard-
Ausgabe angezeigt.)
mkd (mit ohne Argumente)
Generiert einen Syntaxfehler und zeigt die Syntax zum Konsole.
SIEHE AUCH
mkdcppw(1)
GESCHICHTE
1986 - mkd für DOS, und mkdoc für UNIX, sind in ASCII geschrieben für
Labor 'CEM' an der Universität Montpellier (Frankreich).
1991 - mkdoc 3.12 für PC und UNIX (Sun)
1995 - mkdoc 3.22 für Linux Red-Hat
2004 - mkdoc 4 für SUN-SPARC, HP-UX, RedHat, Windows 98, Windows 2000
2007 - 2012 -mkdoc R7.01 bis R12.01 sind auf ISO-Format abgestimmt.
2012 - mkd 12.03 ist umgeschrieben in UTF-8 Format und mkdcppw für C,
c++, und php, ist geschrieben für Fenstern.
AUTOREN
Aktualisiert von : Clara JIMENEZ
Übersetzungen : Alizée (Katalanisch, Spanisch), Luca (Italienisch),
Deutsch (JPL geholfen von Martine)
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
HINWEISE
Diese Version lesen, und Dekodiert nicht, mit '#include' Richtlinie
in der Quelldatei.
Dokuments--generator mkd 3 Dezember 2012 MKD(1)
Betriebssysteme
Debian und Ubuntu
Die Pakete sind versichert für Ubuntu (und Debian) : mkd Pakete und Externe links
Fedora und Red Hat
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
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
mkd pour MS-Windows verwendete Befehlszeile in einem 'cmd' Windows-basierten terminal.
Externe links
Le projet mkd Präsentation des Projekt mkd und seine Derivate mkd* auf der Maintainers Webseite.
Downloads für debian und Ubuntu Software-Bibliothek
Verfügbarkeit der Quellen : Sources für andere Systeme (UNIX, LINUX, WINDOWS)
