Après SPIP 1.9 - doc.spip.org

Publié le : 4 mars 2006 – Dernière modification le 21 décembre 2021 – par Cerdic – 2 commentaires

1
2
3
4
5
1 vote
Une présentation de Piif sur l’outil d’autodoc en cours de construction pour documenter le code.

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

Discussion

5 ans 1 an 3 mois Sans limite
par date
Filtrer

Aucune discussion

Ajouter un commentaire

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparaît.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Qui êtes-vous ?
[Se connecter]

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Suivre les commentaires : RSS 2.0 | Atom