Archives par tags: documentation

Didacticiel :
Créer une documentation automatique avec Doxygen et Sphinx en CI/CD GitLab

Je me suis amusé à écrire une mini librairie C++ pour l'algèbre linéaire (matrices et vecteurs, ...) et j'ai eu envie de générer une documentation à partir du code source.

Je me suis renseigné un peu et j'ai découvert Doxygen, un outil écrit en C++ qui permet de générer de la documentation à partir des codes sources de différents langages (C++, Java, etc.).

Cela fonctionne bien, mais la sortie HTML n'est vraiment pas terrible...

Opinion :
Comment organiser son travail ?

L'organisation du travail peut sembler facile, ce n'est pas toujours le cas, surtout lorsque l'on est impliqué dans 2 ou 3 projets à la fois. Comment se souvenir de ce que l'on a fait il y a un mois alors même que l'on ne sait plus ce que l'on a fait la veille ? Où sont mes documents dont j'ai besoin pour finir ce script ? Qu'est-ce que j'ai fait de ce foutu papier qui parle de la méthode que je dois appliquer ?
Qui d'entre nous ne s'est jamais retrouvé confronté à ce genre de casse-tête ? Très peu j'imagine...