Wikilivres

« Mkd (Extracteur de documents)/mkd-Manuel (fr) » : différence entre les versions

Navigation interactive dans l’historique
← Modification précédenteModification suivante →
Contenu supprimé Contenu ajouté
VisuelWikicode
m WL:RD : ! lien interne
m →‎Manuel : Update
Ligne 203 :
<!--{{Boîte déroulante/début|titre=Manuel (fr) <small>''6 Avril 2013''</small>}}-->
<source lang="text">
MKD(1) MKD(1)
 
 
 
NOM
mkd - make documentation. Extrait des informations codées dans les
programmes sources, et produit une documentation spécifique.
 
Ligne 215 :
 
DESCRIPTION
mkd Des commentaires sélectionnés (ou tous les commentaires) sont
extraits des programmes sources: 'chemin_source', et sont copiés
copiés dans un fichier documentaire: 'chemin_cible', afin de produire
produire une documentation spécifique . Habituellement les fichiers
fichiers documentaires sont des Organigrammes, des Structures de
de programme, des commentaires pour Programmeurs, des points de
Test et 'warnings' .... Les codes de sélection peuvent être
respectivement 'O', 'S', 'P', 'T' et 'www' juste après le
caractère début de commentaire.
 
codes Les commentaires commençant par ces caractères sont extraits du
programme source et sont ajoutés au fichier documentaire. Tous
les caractères ASCII peuvent servir a coder les commentaires,
toutefois on utilise habituellement des caractères majuscules,
sauf w pour 'warning'. Avec deux étoiles en paramètre codes, mkd
mkd extrait tous les commentaires. (Voir aussi option t et les
exemples).
 
Ligne 237 :
 
chemin_cible
Chemin du fichier documentaire. Par défaut chemin_cible est une
copie de chemin_source auquel on remplace le suffixe par le
suffixe ´.doc´.
 
Ligne 259 :
options en minuscules:
 
-a (append) Ajoute a la suite du fichier documentaire
´chemin_cible´.
 
-f (find) Trouve le langage du fichier source par analyse du
suffixe. (s´utilise généralement avec un fichier projet). mkd
reconnait les extensions suivantes: .asm, .s; .bas, .vb, .bat;
.C, .H, .D, .cc, .hh, .cp, .cs, c#, .c++, .h++, c--, h--, .cpp,
.hpp, .css, .pr, .pl, .php, .jav, .jse .js; .for, .f; .pas, .p;
.sh, .csh , .pl, .rb, .py, .pyw; .pj, .prj
 
-j (project) S´utilise avec un fichier projet composé de sources sourcesen
en langages différents.
 
-l (lignes) Extrait les lignes commençant par les caractères CD1 ou
Ligne 289 ⟶ 293 :
-s (screen verbose) Duplique les commentaires extraits sur la
sortie standard.
 
 
-t (text) Ne copie que le commentaire.
Ligne 299 ⟶ 302 :
 
mkd -Ct F manual mkd.1 | gzip -f mkd.1.gz
(Produit un manuel UNIX en francais. au format UTF-8 depuis la
version 12.03) C: pour décoder le fichier en langage C, s:avec
visualisation à l´ écran, t:ne copier que le commentaire,
F:sélectionner les commentaires debutants par F.
 
mkd -Ct M manual mkd.1 | gzip -f mkd.1.gz
(Produit un manuel UNIX standard en anglais au format UTF-8
depuis la version 12.03)
 
mkd -Csl '*Sied' mkd3.c '*.verif_struct'
(avec les options de compilation CD1 ou CD2 = '#', produit une
documentation avec la structure du programme, avec les: include,
include, define, ifdef, else, et endif, des options de decompilations afin
compilations afin de vérifier la structure du programme.) C:décoder les
C:décoder les commentaires style C, s:vérifier à l'écran, l:décoder egalement
l:décoder egalement des lignes commencant par les caractères CD1 ou CD2 ou CD3 et
CD1 ou CD2 ou CD3 et suivis des char_codes:*Sied.
 
mkd -jfsl '*OHie' mkd_docu.prj mkd.org
(avec les options de compilation CD1 ou CD2 = '#', produit un
organigramme. Les commentaires commencent par *,O,H, et les
fichiers sources sont listés dans le fichier projet.) f:trouver
le style de langage, j:le fichier source est un fichier projet
qui contient la liste des fichiers a documenter.
 
mkd -l '*ide' mkd3.c '*.id_ei'
(avec les options de compilation CD1='#' ou CD2='#', décode les
#includes, #define, #ifdef, #else, #endif des options de
compilation en C ).
 
mkd -pj '**' mkd_docu.prj mkd.strings
(avec les options de compilation CD4=CD5=´\"´, extrait les
chaînes de caractères du programme. (les commentaires sont
transmis a la sortie standard).
 
mkd (sans argument)
Génère une erreur et envoie la syntaxe au terminal avec les
caractères compilés pour les options l et p.
 
Ligne 344 ⟶ 347 :
 
HISTOIRE
1986 - mkd pour DOS, et mkdoc pour UNIX, sont écrits au format format ASCII
ASCII par Jean-Paul Louyot pour le laboratoire 'CEM' de l'université de
l'université de Montpellier (France).
 
1991 - mkdoc 3.12 pour PC et UNIX (Sun)
 
1995 - 2004 - mkdoc 3.22 à mkdoc 4 pour Unix et Linux: SUN-SPARC, HP-
UX, RedHat
 
2004 - mkdoc 4 pour Linux Ubuntu, Windows 98, Windows 2000
 
2007 - 2012 - de mkdoc R7.01 à mkd R12.01 sont au format format ISO-8859-1.
ISO-8859-1. Le nom 'mkdoc' est abandonné avec la version 10.01 compilée avec
compilée avec Visual C++ 2010
 
2012 - mkd 12.03 adapté au format UTF-8 pour son soninternationalisation.
internationalisation. Dans la foulée mkdcppw est écrit pour les styles de langages C++ (C,
de langages C++ (C, c++, c#, php, java, javscript, CSS, etc.) en mode graphique avec gcc et
graphique avec gcc et 'gtkmm' (fenêtres).
 
TELECHARGEMENTS
http://edeulo.free.fr/wiki/index.php/Projet_mkd/Compilations_UNIX-LINUX
LINUX
 
AUTEURS
Ligne 383 ⟶ 385 :
 
NOTES
Il appartient aux programmeurs de veiller à refermer les commentaires,
blocs et lignes, par les codes de fermeture appropriés dans les
fichiers sources.
 
Attention: La fermeture d'un commentaire ligne est un retour chariot (
( NL, LF, CR/LF) selon les cas.
 
En fin de fichier: cette note implique un retour chariot en fin de
commentaire ligne. Dans ce cas vous devez avoir une ligne vide à la fin
fin du fichier source.
 
Remarque: Cette version ne lit et ne décode pas les fichier inclus par
'#include' dans les sources.
 
Ligne 406 ⟶ 408 :
 
 
6 Avril11 Mai 2013 MKD(1)
</source>
<!--{{Boîte déroulante/fin}}-->
Récupérée de « https://fr.wikibooks.org/wiki/Mkd_(Extracteur_de_documents)/mkd-Manuel_(fr) »