L’idée est de construire un site spip de documentation à partir du code
- un article par fonction du code
- ajout de commentaires dans le code au dessus de chaque fonction qui renvoie automatiquement vers l’article de la doc
Chaque article peut ensuite être écrit pas des contributeurs/documenteurs (ie notamment les codeurs qui vont pas s’en tirer comme ça)
Objectif
pouvoir documenter le code sans comit
Avoir une doc de référence du code
Prochaines étapes
- Définir la tête des url propre
- Comment gérer les fonction déplacées dans le code, qui ont disparues du code, qui sont définies à plusieurs endroits
- Tester que le code modifié par la moulinette de doc n’est pas impacté (commentaires placés aux mauvais endroit à cause d’une ’function’ dans une chaîne de texte par exemple)
- Modifier TRAC pour transformer les commentaires du code avec l’url doc en lien cliquable
version
RSS 2.0