HeaderBrowser

Documentation : Introduction



Qu'est-ce que c'est ?
Lorsque vous créez des bibliothèques de fonctions en C ou en C++ (ou avec d'autres langages, mais ce n'est pas notre propos), vous devez fournir une documentation. Les autres programmeurs qui vont se servir de vos bibliothèques ont juste besoin de savoir ce qu'il y a à l'intérieur de vos fichiers, quelle est l'API.
Le but de Header Browser est de vous aider à écrire ces documentations. Vous avez simplement à écrire des commentaires spéciaux dans vos fichiers d'en-tête. Voici un exemple simple de commentaire Header Browser pour une fonction :
/*!
 * @function    cuirePoulet
 * @abstract    Cuit un poulet avec la sauce désirée.
 * @discussion  Cette fonction prend un poulet, le vide,
 *              le prepare avec la sauce voulue et le rotit.
 * @param       poids     Le poids du poulet.
 * @param       sauce     La sauce a utiliser. Peut etre un
 *                        pointeur NULL.
 * @result      Un pointeur sur le poulet cuit.
*/
poulet_t     *cuitPoulet(int poids, epice_t sauce);
Utilisés avec HEader Browser, ces commentaires vont générer votre documentation, avec plusieurs formats possible.
Le format de sortie recommandé est la sortie HTML par défaut. Elle affiche les informations de manière claire et efficace. Essayez-la et vous ne pourrez plus jamais écrire vos documentations autrement :-)

L'obtenir, le compiler et l'installer
La page de téléchargement vous propose différents fichiers. Si vous souhaitez récupérer le code source de HEader Browser, téléchargez la dernière version, décompressez-la et lisez les fichiers README et INSTALL.
Si vous voulez uniquement exécuter Header Browser, téléchargez directement l'exécutable relatif à votre machine.

Page suivante : Commentaires HeaderBrowser


Copyright © 2000-2001  |  Informations sur la licence