[spip-dev] Documentation au format PHPDoc du code SPIP

Dev
1

Salut,

Pour pleins de raisons, je pense que ce serait bien si les fonctions de SPIP pouvaient être commentées au format PHPDoc.
Mais je suis convaincu que ce n’est pas au développeurs de tout reprendre.

Je propose donc qu’on ouvre une série de tickets dans le Trac pour suivre les documentations et proposer des patchs : c’est la méthode choisie par Wordpress
(ex. http://core.trac.wordpress.org/ticket/7527, etc…) : cf. http://codex.wordpress.org/Inline_Documentation
Perso je n’y vois aucun inconvénient.

Qu’en dites-vous ?

.Gilles

2

S'lt

Pour pleins de raisons, je pense que ce serait bien si les fonctions de SPIP
pouvaient être commentées au format PHPDoc.

Ce travail est déjà en cours par certains des dev.

Mais je suis convaincu que ce n'est pas au développeurs de tout reprendre.

doc.spip.org doit aider à la normalisation de la documentation aussi

Pour info il est conseillé de se baser sur JavaDoc et l'implémentation
Doxygen qui sera plus complète que PhpDoc.
Km