Après SPIP 1.9 - doc.spip.org

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

Dernière modification de cette page le 9 février 2019

Discussion

2 discussions

  • 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

  • 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

Ajouter un commentaire

Qui êtes-vous ?

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