Projet mkd/mkd/Aide
De Wiki EELL.
Retour vers Shell_command_projects/mkd ↑
Sommaire |
Exemple d'utilisation
Fichiers de fonctions
Quand c'est possible on écrit chaque fonction d'une application dans un fichier séparé.
Quand les fonctions sont regroupées dans un même fichier, la documentation des fonction apparaîtra dans le même ordre que dans le fichier.
Dans le fichier de la fonction on précise sa syntaxe d'utilisation et son usage (header).
Exemple pour la fonction cpp_ : dans le fichier cpp_.c
Notez qu'il est préférable d'écrire en anglais pour une meilleure traduction.
Voir l'aide en anglais.
/*P
fichier cpp_.c
Directives programmeurs (cycle en V)
Dernière date de modification et nom du programmeur
*/
/*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).
Les variables globales sont les '''codes''' et les '''options''' définis
dans la fonction appelante:
Les codes, tableau 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 et permet les redirections > , >> ,
ou || etc.
v: mode bavard
Remarque :
Si la détection d'un commentaire à transcrire commence par les caractères
/* il sera transcrit jusqu'à rencontrer les caractères */ quels que
soient les commentaires lignes inclus dans ce commentaire.
Si la détection d'un commentaire commence par les caractères //, la ligne
commentaire sera copiée 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 Unix/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);
*/
int cpp_ (FILE * pfdoc, FILE * pnfile)
{//S Fonction début
... // Lignes de programme
}//S Fonction fin
Fichiers de commande et Makefile
Toutes les chemins des fichiers de l'application sont regroupés dans un fichier de projet dans l'ordre alphabétique.
- Exemple : "ls -1 *.c > app.prj" qui va contenir le nom de tous les fichiers à examiner pour générer la documentation. Attention, ls -1 (chiffre un) et non -l (lettre 'l')
Dans les exemples qui suivent on utilise les caractères H et D pour générer la documentation.
Il est d'usage d'utiliser:
- D ou F Fonctions - pour générer le fichier documentaire des fonctions
- G Général - doc générale
- H Header pour générer le fichier d'entête .h
- M Manuel (En anglais. Sous Unix / Linux : « Man (1) » ou autre )
- O Organigramme ou pseudo-code
- P Programmeurs - doc programmeurs (cycle en V)
- S Structure - {/*S*/ ... ou avec "//" }//S
- U Utilisateurs - doc. destinée aux utilisateurs
- e note en anglais
- f note en français
- w warnings - Attention !
Tous les caractères ASCII sont utilisables, lettres et chiffres.
La ligne de commande "'''mkd -Cjt H app.prj app.h'''" génère le fichier d'entête de toutes les fonctions de l'application.
La ligne de commande "'''mkd -Cjt D app.prj app_functions.documentation'''" génère le fichier de la documentation des fonctions de l'application.
Exemple de lignes dans un Makefile.
Dans cet exemple le Makefile se trouve dans le répertoire des fichiers sources du projet.
APP = MyProgram # This is any "macro"
Create_header_and_functions-doc: # here, this is any unconditional directive.
if [ -e "/usr/bin/mkd" ]; \ # Warning: the first char is a tabulation and not spaces
then \
ls -1 *.cpp > $APP.prj; \ # first create or overwrite new project file
mkd -Ctw H $APP.prj $APP.h: \ # create or overwrite header file
mkd -Ctw D $APP.prj $APP.txt: \ # create or overwrite functions documentation
mkd -Cwn w $APP.prj $APP.wars; \# create or overwrite warnings doc. for programmers
else \
@echo "The mkd command is not found in /usr/bin directory"; \
fi
Générer la documentation avec mkddocu
mkddocu est un utilitaire introduit avec les versions mkd de 2014. (mkd-doc_140515_all.deb)
Cet utilitaire facilite l'édition de la documentation logicielle standard.
On place la commande mkddocu dans le fichier de compilation ou dans le Makefile. La documentation est ainsi régénérée à chaque compilation après correction des fichiers du répertoire source.
On peut aussi se placer avec un terminal dans le répertoire des sources du projet et de lancer la commande mkddocu.
Il est aussi possible de copier le shell /usr/bin/mkddocu dans le répertoire des sources et le renommer (mkddoc.sh) pour éviter les interférences avec mkddocu. Shell que l'on peut adapter à volonté.
Voir le manuel de mkddocu
Voir aussi la discussion mkd 140515 disponible
