Créer une documentation à partir de fichiers bien commentés

Dans n’importe quel projet, la documentation est presque indispensable dans la mesure où l’on passe plus de temps à relire et à maintenir du code qu’a en écrire… Commenter le code source est tout aussi important et permet d’intervenir beaucoup plus rapidement sur le code, même après quelques mois voir années. Il permet aussi à quelqu’un qui reprend le projet de mieux comprendre comment il fonctionne.

Seulement, une fois que l’on a commenter, on doit à nouveau s’occuper d’écrire la documentation, chose très ennuyante. Afin d’aider au maximum les développeurs, il existe de nombreux outils pour créer des documentations à partir du code source comme PHPDocumentor.

Continue reading Créer une documentation à partir de fichiers bien commentés

facebooktwittergoogle_plusredditpinterestlinkedinmail