Aller au contenu

Mkd (Extracteur de documents)/Comprendre les fichiers de projets

Un livre de Wikilivres.
Make documents

Exercices pour se familiariser avec les fichiers de projets

[modifier | modifier le wikicode]

Les fichiers de projets d'extension .prj ou .pj sont des fichiers qui contiennent la liste des fichiers (sources) pour générer les documents (cibles).

Les fichiers de la liste ont parfois des extensions différentes.

Si les fichier sont tous de même style de commentaires on peut imposer une des options impératives pour générer les documents, mais pour utiliser un fichier de projet il est nécessaire de préciser que le fichier source est un fichier de projet avec l'option -j souvent associé à l'option -f (find). Dans le cas où find ne trouve pas le type de fichier, les styles compilés sont proposés à la sortie standard (Terminal en général)
L'option -j est compatible avec les options impératives.

Créer un fichier de projet manuellement

[modifier | modifier le wikicode]

Projet exercice.prj ; à créer manuellement avec les fichiers disponibles asm.c cpp.c putchar.s


Créer un fichier de projet avec les commandes système

[modifier | modifier le wikicode]

Projet exercice.prj ; à créer avec les commandes de votre système d'exploitation; ls, dir.


Créer un fichier de commandes pour :

[modifier | modifier le wikicode]

Vous aurez copié les fichiers à éprouver dans le répertoire des essais . exécutez la commande mkd \? pour visualiser les extensions reconnues par votre mkd. Ces extensions dépendent des options de compilation.

Les fichiers sont écrits dans des langages de programmation différents, le but est de créer des documentations globales avec ou sans le finder (option -f).


Mettre à jour le fichier d'entête. header global
[modifier | modifier le wikicode]

exercice.h


Mettre à jour l'organigramme de chaque fichier de programme
[modifier | modifier le wikicode]

Pseudo-code; Code de repérage 'O',
asm.org, cpp.org, putchar.org


Mettre à jour la structure de chaque fichier
[modifier | modifier le wikicode]

avec le pseudo code. Code 'S' et 'O' et 'w',
asm.struct

putchar.struct

Mettre à jour la documentation globale pour les programmeurs
[modifier | modifier le wikicode]

avec les dates de mise à jour etc. Code 'P'
exercice.info_programmeurs


Mettre à jour de la documentation logicielle globale
[modifier | modifier le wikicode]

(Conception détaillée, Tests unitaires, du cycle en V) Code 'D'
exercice.docu

Notes et références

[modifier | modifier le wikicode]