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
Vos commentaires
# Le 20 mai 2006 à 10:27, par Loiseau2nuit
En réponse à : Après SPIP 1.9 - doc.spip.org
C’est une bonne idée. J’avais déjà plus u moins commencé à réfléchir à une version de spip un peu académique avec full commentaire de code, articles de méthode préenregistrés dans une ou deux rubriques exemple et des liens vers sites d’infos... pour d’une part visualiser le site plus rapidement après l’install sur serveur, et d’autre part, avoir sur place une série de conseils, et tips pour te lancer dans ta personnalisation de site.
Par contre je maitrise assez peu tout ce qui est « Trac » "SVN" et autre outils de dev communautaire.
Répondre à ce message
# Le 18 mars 2006 à 19:45, par JavSP
En réponse à : Après SPIP 1.9 - doc.spip.org
Tres interesant.
Je crois que il doit etre organisé par :
- version
- module
- fonction
Si une fonction disparaitre, poser une entreé con une reference que cet fonction ja n’existe pas.
Répondre à ce message