« Mkd (Extracteur de documents)/Comprendre les options » : différence entre les versions
Contenu supprimé Contenu ajouté
→Mettre à jour de la documentation logicielle globale : Sauvegarde provisoire |
|||
Ligne 478 :
titre=Aperçu|
solution=
'''mkd -fjst D exercice.prj *.docu'''
<pre>
exercice.docu
Fonction asm_(); Fichier asm.c
Documentation simplifi�e.
-------------------------
La fonction asm_() doit d�coder des commentaires, pr�-cod�s avec un caract�re ASCII qui suit le d�but de commentaire. exemple ;A en 'd�but' ou 'dans' la ligne.
... et bla bla bla ...(raccourci pour les exercices)
Tests unitaires:
----------------
La fonction doit �tre �prouv�e de telle sorte qu'un commentaire qui se termine par le caract�re de fin de fichier soit enti�rement copi� dans le fichier cible.
Le caract�re de fin de fichier d�cod� avant le caract�re de fin de ligne doit �tre remplac� par un caract�re de fin de ligne. Le caract�re de fin de fichier (EOF) ne doit jamais appara�tre dans texte du fichier cible.
fonction asm_
-----------------------------------------------------------------------------
NOM DU FICHIER; asm.c
ACTION:
La fonction asm_ lit le fichier �crit en assembleur et extrait les
renseignements de structure, l'organigramme, la documentation destin�e
aux programmeurs, au fichier d'ent�te (.h) ou � la documentation
destin�e � l'utilisateur etc.
On utilise ici les codes d'identfication des commentaires suivants :
D: pour la documentation g�n�rale sur les fonctions (listing)
H: pour g�n�rer le fichier d'ent�te (header, .h ou .hpp)
O: pour l'organigramme
S: pour le contr�le de la structure du programme
T: pour les points de tests
U: pour la documentation utilisateur
Options :
n : num�ro de ligne (ajoute du num�ro de ligne)
s : �cran (ajoute le commentaire � l'�cran)
t : texte seul (ne copie pas les caract�res de rep�rage)
SYNTAXE:
#include "version.h"
#include "asm.h"
int asm_(FILE *pfdoc, FILE *pnfile);
PORTABILITE:
Win32 Win64 UNIX/Linux x86 et amd64
DESCRIPTION:
FILE *pfdoc : pointeur sur le flux du fichier de destination
File *pnfile : pointeur sur le flux du fichier source
VALEUR RETOURNEE:
Ne retourne rien
DROIT DE COPIE:
� mkd, EUPL 2007, pr�cis�e dans version.h
Fonction cpp_(); Fichier cpp.c
Documentation simplifi�e.
-------------------------
La fonction doit d�coder des commentaires, pr�-cod�s avec un caract�re ASCII qui suit //D le d�but de commentaire. exemple //A ou /*A
... et bla bla bla ...(raccourci pour les exercices)
Tests unitaires:
----------------
V�rifiez les options n, s et t s�par�ment:
V�rifiez que la num�rotation des lignes est correcte dans tous les cas de d�codage (lignes et blocs). n, ns. nt, nst.
V�rifiez que le texte reste � la bonne place dans tous les cas de d�codage: toute la ligne (dans la cas de la directive de compilation FULL_LINE), ou texte seul.
-- V�rifiez que les tabulations sont bien prises en charge dans tous les cas, d�codage des lignes et des blocs.
-- V�rifiez de m�me pour les espaces.
La fonction doit �tre �prouv�e de telle sorte qu'un commentaire qui se termine par le caract�re de fin de fichier soit enti�rement copi� dans le fichier cible.
Le caract�re de fin de fichier d�cod� avant le(les) caract�re(s) de fin de commentaire doit �tre remplac� par un caract�re de fin de ligne.
Le caract�re de fin de fichier (EOF) NE DOIT JAMAIS APPARA�TRE DANS LE TEXTE DU FICHIER CIBLE.
Ceci provoquait un bug dans la version Alpha de l'application fen�tr�e mkdcppw � l'�tape du test d'int�gration.
function cpp_
-----------------------------------------------------------------------------
FILE NAMES: cpp.c and cpp.inc.c++ with gtkmm for mkdcppw
( Comments in UTF-8 with Bluefish text editor )
ACTION:
The cpp_ function reads the source file (pnfile) transmitted from the
calling function, and d�codes the comments pre-encoded in lines or
blocks of style c++. and then writing this comments in a target file
(pfdoc).
Pre-coded characters are defined in a external global table 'Codes';
The golbal variables are 'Codes' and 'Options'.
The 'Codes': table of 5 characters:
extern char codes[];
They must be d�fined in the calling function:
char codes[5] = {0,0,0,0,0};
The 'Options': n,s,t,v.
extern unsigned char n,s,t;
They must be dEfined in the calling function:
unsigned char n=0,s=0,t=0;
With the options:
n: The transcript is preceded by line number. This allows to easily
reach the commented line.
s: Add the comment to the screen to use shell redirections > , >> ,
or || etc.
t: With the t option only the commented text is copied.
Without the t option the entire line or block is copied.
The t option permit to generate directly exploitable and publishable
documents.
Remark:
If the decoded comment begins with the characters "/ *", the comment
is copied until find the characters "* /", whatever included any
comment-line starting with "//".
If the decoded comment begins with the characters "//", the line is
copied until find the end-of-line or new-line 'NL' character or
end-of-file 'EOF'.
This provisions facilitate the automatic generation of header files
(file.h ; .hpp ; etc.) and documentation of functions.
SYNTAX:
In UNIX / LINUX environnement:
#include "/usr/include/mkd/version.h" // IMPORTANT: Compilation directives
#include "/usr/include/mkd/cpp.h"
int cpp_(FILE * pfdoc, FILE * pnfile);
PORTABILITY:
Microsoft Visual studio under Windows : x86(Win32) x64(Win32 and WIN64)
gcc under Unix / Linux.
DESCRIPTION:
cpp_ fonction
FILE * pfdoc: pointer of the target file opened by the calling function
FILE * pnfile: pointer of the source file opened by the calling function
RETURN VALUE:
Return 0 in case of success in konsole version, nothing with gtkmm.
COPYRIGHT: (Specified in version.h)
SEE ALSO MANUAL:
Man(3) attached in English.
Command line : man 3 cpp_
Fichier putchar.asm sous DOS/Windows
Fichier putchar.s sous Unix/Linux
macro putchar
----------------------------------------------------------------------------
putchar est une macro MASM qui affiche un caract�re sous MS-DOS.
On l'utilisera par exemple ainsi
putchar "X"
Et cela g�n�rera :
mov dl,"X"
mov ah,2
int 21h
</pre>
}}
===== Fichier de commande du test unitaire de la fonction cpp.c =====
| |||