#1 Le 03/04/2010, à 16:38
- jp-de-cardabela
Génie Logiciel :: La documentation logicielle
Bonjour 
,
Je viens de remettre au gout du jour un petit utilitaire mkd qui est resté dans l'oubli.
Noms successifs de cet utilitaire : mkd (1989 pour MS-DOS), mkdoc (Pour UNIX), puis makedoc, aujourd'hui revenu à mkd.
Aujourd'hui je suis retraité depuis 10 ans, j'avais juré de ne plus m'impliquer dans l'informatique à ma retraite.
Par des circonstances de vie j'ai dû m'y remettre et je me suis aperçu que la documentation logicielle est restée désespérément stagnante. Je ne suis pas sûr qu'aujourd'hui plus qu'hier les programmeurs soient plus excités par cette documentation logicielle qui pourtant rend de grands services pour l'édition et la maintenance.
Aujourd'hui encore les programmes écrits il y a longtemps sont encore bien clairs et faciles à mettre à jour.
Si des programmeurs sont intéressés par cet utilitaire du même niveau que make, grep, etc. je les invite à se rendre sur le site de distribution actuel edeulo.free.fr et d'y contribuer pour ajouter des modules utiles pour les nouveaux langages (et langages mixtes) de programmation.
Je ne détiens pas le monopole des lignes de code bien que j'en aie été à l'origine, mais je tiens à ce que ces lignes de codes restent dans le domaine public distribués en logiciel libre.
Cordialement à tous 
Dernière modification par Kanor (Le 03/04/2010, à 17:04)
Le Logiciel Libre : http://edeulo.free.fr/index.php
Hors ligne
#2 Le 03/04/2010, à 16:55
- geenux
Re : Génie Logiciel :: La documentation logicielle
Il y a doxygen qui est très utilisé par de nombreux gros projet : Qt, Ogre, Irllicht, SFML...
Ça permet de documenter ses classes, les fonctions, les variables, de réaliser des graphes représentant les relations entre les différentes classes...
Bref, tout plein de possibilités qui semblent plus ou moins correspondre à ce que tu veux faire.
Hors ligne
#3 Le 03/04/2010, à 19:32
- jp-de-cardabela
Re : Génie Logiciel :: La documentation logicielle
Il y a doxygen qui est très utilisé par de nombreux gros projet : Qt, Ogre, Irllicht, SFML...
Ça permet de documenter ses classes, les fonctions, les variables, de réaliser des graphes représentant les relations entre les différentes classes...
Bref, tout plein de possibilités qui semblent plus ou moins correspondre à ce que tu veux faire.
Merci pour ta réponse.
Je connais doxygen.
Bien qu'il ait été oublié, mkd qui a maintenant 21 ans est moins pointu que doxygen, ratisse plus large, s'intègre parfaitement dans le MAKEFILE, sa fonction est différente.
Ce programme s'inscrit dans le COFF (Common Object File Format)
Une application peut associer des programmes écrits dans différents langages, et les modules sont associés par les objets (voire des librairies liées dynamiquement).
Pour utiliser les objets ou les librairies il faut disposer de la documentation d'utilisation de chaque fonction. C'est ce qui nous est fourni quand on utilise un compilateur.
Pour ce faire chaque fonction doit être écrite dans un seul fichier et faire l'objet de tests unitaires (ou/et de tests intégrés pour une application). Ensuite on génère la documentation que l'on intègre dans les manuels .1 .2 .8 etc.
mkd ne fait pas que cela. Il peut aussi générer le pseudo code, la structure, les point particuliers d'attention, etc. qui permettent aux programmeurs de vérifier la cohérence d'un programme.
mkd a été, à l'origine, écrit pour les langages Assembleur, C, Fortran, Pascal, enfin les langages utilisés dans les années 90.
Il convient maintenant de le mettre à jour pour les nouveaux langages.
C'est assez facile car on a souvent repris les mêmes caractères pour délimiter les commentaires, #, ; , //, /* ...*/, %, etc.
mkd reconnaissant un certain nombre de langages par leur extension, .sh, .c, .for, etc. il suffirait de rajouter la reconnaissance de .php, .html, etc. bien que, s'il ne trouve pas, il demande quel style de commentaire à décoder !
Excusez pour tous les etc.
Salutations cordiales.
Dernière modification par jp-de-cardabela (Le 05/04/2010, à 12:47)
Le Logiciel Libre : http://edeulo.free.fr/index.php
Hors ligne
#4 Le 25/02/2012, à 12:49
- é2lo
Re : Génie Logiciel :: La documentation logicielle
Bonjour,
l'utilitaire, mkd 12.01 pour console a été mis à jour pour ubuntu en janvier 2012.
Un utilitaire mkdcppw (graphique est à l'étude.) discussions en cours
Rappel :
L'utilitaire mkd est destiné à 'install', et au 'makefile' de compilation pour la mise à jour automatique des documents, notament les fichiers d'entête modifiés, les manuels, la documentation utilisateurs, etc.
mkd est utilisé pour la pluspart des langages de programmation, y compris les shells.
Nouveau :
mkdcppw est une application à l'usage des programmeurs en C, C++, PHP Elle permet de visualiser immédiatement un organigramme, un défaut de structure, retrouver les points de tests, les recommandations programmeurs; les 'warnings', etc. comme avec mkd mais en plus, de les imprimer. en cas de nécessité
mkdcppw sera une application multilingue. Actuellement elle est dévelopée en anglais avec traduction automatique en français.
A bientôt peut être sur notre forum ?
é2lo
é2lo
Hors ligne