Tentation de geek
Par Laurentj le lundi, septembre 4 2006, 17:55 - Geek-log - Lien permanent
J'utilise phpdoc pour générer la documentation de réference de Jelix. Globalement, il répond à mes besoins sur le papier. Cependant, il a des défauts :
- j'ai rencontré pas mal de bug. Et le fait qu'il soit sortie dans une nouvelle version récement n'y a rien fait (il y a eu quand même 6 releases candidate !).
- d'ailleurs, même si l'architecture globale du code n'est pas trop mauvaise, son code source est assez obscure : on voit qu'il y a des portions de code de qualité inégale qui ont été rajoutés au fil des ans (et qui ont causé les bugs de regressions que j'ai trouvé), et du coup, je n'ai pas eu le temps d'aller trés loin dans mes tentatives de corrections de bugs..
- c'est une appli plutôt lourde, et lente
J'ai bien essayé de regarder ailleurs, mais le seul truc que j'ai trouvé, et qui soit à la hauteur (et relativement compatible) au niveau des tags, est doxygen (mais difficilement personnalisable, pas de templates...).
Ce week end, phpdoc m'a assez énervé. Et que fait un développeur quand il ne trouve pas son bonheur avec les outils qu'il a ? Il le fait soit même ! Et donc j'ai eu une de ces envies de programmer, de faire un générateur de document from scratch, léger, php5 only, avec un système de template léger (basé sur jtpl bien sûr).. et tout et tout. Ça a fourmillé dans ma tête tout le week-end, à me demander comment j'allais faire ceci, cela, à me demander si ça valait le coup que je me lance là dedans, à tenter d'évaluer le travail à faire.
Mais finalement, aprés de longues reflexions, j'ai pu me convaincre que ce n'était pas raisonnable. Ma todo list est assez chargée comme ça :-) Mais peut-être qu'il y a un développeur qui s'ennuie dans le coin ? :-)
En attendant, j'ai décidé de rester avec phpdoc et de poster des bugs sur le site du projet... :-|
Commentaires
Et pkoi pas un projet d'exemple/demo pour jelix ? je dis une connerie p.e. ?
De la "meta" documentation qui genere la doc en etant soit même de la doc ... un truc à chopper mal au crane :)
j'y ai pensé, mais j'ai déjà une demo en cours de réalisation, qui elle aussi va me servir de base pour d'autres trucs. J'ai vraiment un manque de temps :-)
Qu'est-ce qui cloche avec doxygen ? Il suffit de choisir le mode de sortie XML, et de générer ton HTML perso avec des transfos XSLT.
hum.. XSLT... comment dire... Indigeste pour moi...
J'ai essayé phpDocumentor également mais il ne m'a pas convaincu.
Je croyais beaucoup en Doxygen, il me paraissait très bien avec son plugin eclipse mais hélas il a un gros problème avec l'unicode (qu'il ne gère pas) et du coup des caractères exotiques remplacent les caractères accentués dans ma documentation :-(.
hum.. XSLT... comment dire... Indigeste pour moi...
C'est domage car XSTL est l'un des outils les plus puissant de XML ;-)