Partage
  • Partager sur Facebook
  • Partager sur Twitter

Générer la documentation

Sujet résolu
    26 juillet 2010 à 14:37:45

    Bonjour!

    j'ai fini mon projet et l'on me demande une documentation technique, en particulier la description des fonctions codées.

    PAs de problème, mon code est bien commenté, c'est surtout de la mise en forme.

    Je sais que dans eclipse, en particulier en java, on peut générer la doc d'un clic si celle ci est bien propre du type :

    /**
    * description
    * @param ...
    * @param ...
    * @return ...
    */

    J'ai téléchargé la version hélios de eclipse (pour php donc) et j'ai cherché cette fonction, le problème, c'est que c'est toujours de la javadoc qui est générée, et donc eclipse me dit que mon fichier de fonction n'est pas du java. (normal, c'est du php)

    Pour ceux qui ne savent pas a quoi ressemble la javadoc, allez ici ( http://java.sun.com/j2se/1.5.0/docs/api/ ) pour voir ce qu'eclipse est capable de générer.

    C'est un résultat de ce type que j'attendais.

    qqn connais une autre solution (ou autre logiciel )pour générer une doc propre en fonction de ce type de syntaxe sur les paramètre?


    Merci d'avance :)
    • Partager sur Facebook
    • Partager sur Twitter
      26 juillet 2010 à 15:19:00

      salut chinoisfurax :)

      ça à l'air par mal, je teste :)

      Merci ;)
      • Partager sur Facebook
      • Partager sur Twitter
        26 juillet 2010 à 15:23:52

        De rien.
        Je me suis souvenu qu'on en parlait sur un tuto ici. J'ai du rechercher un peu, c'était dans le tuto de vyk12 sur la POO dans un TP. Même syntaxe que javadoc.
        • Partager sur Facebook
        • Partager sur Twitter
          26 juillet 2010 à 15:31:57

          Tien d'ailleurs je profite du topic...

          Si l'on regarde la doc de php on a pas mal d'informations en plus que ce que les tags suggère.

          eclipse par exemple reconnais @param, mais si je regarde la doc php on peu de temps en temps voir un cadre "Erreur/Exception" Et si on veux documenté cela... comment on fait pour savoir quel tag mettre ?

          On peu également tant que l'on y est parler de "exemple". Imaginons que moi je veuille tout mettre dans le code (d'accord ce choix pourrait être discutable), je créée des tags et je créée mon propre parseur ?
          • Partager sur Facebook
          • Partager sur Twitter
            26 juillet 2010 à 15:59:44

            J'ai regardé les deux, et doxygene est plus rapide, plus agréable et plus complet... dois-je dire lequel ai-je choisi? :p

            Merci à vous ;)

            @La source : doxigene semble te permettre de faire des 'custom tags'. j'ai pas pris le temps de bien comprendre, mais ça semble correspondre à ta question
            http://www.stack.nl/~dimitri/doxygen/custcmd.html

            partir de ceci :

            Citation

            ALIASES += Bold{1}="<b>\1</b>"



            pour arriver à un truc du genre cela :

            Citation

            ALIASES += exemple{1}="<div class="exemple">\1</div>"



            à tester ;)
            • Partager sur Facebook
            • Partager sur Twitter
              26 juillet 2010 à 16:06:41

              D'accord ;)

              Merci pour l'info.
              • Partager sur Facebook
              • Partager sur Twitter
                26 juillet 2010 à 16:08:17

                Je penserai à voir doxygen quand j'aurai besoin d'une doc alors :)
                • Partager sur Facebook
                • Partager sur Twitter
                  26 juillet 2010 à 16:22:05

                  Citation : La source

                  D'accord ;)

                  Merci pour l'info.



                  de rien ;)

                  Citation : Chinoisfurax

                  Je penserai à voir doxygen quand j'aurai besoin d'une doc alors :)


                  l'avantage principal de phpdocumentor, c'est qu'il est en php, tu le met dans ton www et voilà, ultra portable donc.
                  doxygene s'installe est est compilé, c'est normal qu'il soit plus rapide.
                  Phpdoc à un style css devant dater des année 90, alors même avec la sobriété windowsienne dont fait preuve doxygène, ça rend mieu que phpdoc ^^
                  Et les fonctions sont très avancées dans doxigène, tu peux choisir ton header en haut de chaque fichier html : concrétement, avec un peu de travail, je suis sûr qu'on peut intégrer casiment totalement la doc au style global de ton site. (j'ai testé voir ce que ça donnais en applicant juste mes css, ça a été le gros fail! normal, faut du coup faire la correspondance entre mes class css et les class de docigene. Je m'y pencherais plus tard)

                  en tout cas, merci à vous. problème résolu!

                  La source, si un jour tu te penche sur la gestion des exemple et autre dans doxigene, je veux bien être tenu au courant ;)
                  • Partager sur Facebook
                  • Partager sur Twitter
                    26 juillet 2010 à 16:25:38

                    Citation : miatec

                    La source, si un jour tu te penche sur la gestion des exemple et autre dans doxigene, je veux bien être tenu au courant ;)



                    Sa sera pas pour demain (pas de projet en cour actuellement) Mais si ta demande porte sur le long terme (+ d'un mois) alors oki je note ;)
                    • Partager sur Facebook
                    • Partager sur Twitter
                      26 juillet 2010 à 16:35:19

                      Citation : La source

                      Citation : miatec

                      La source, si un jour tu te penche sur la gestion des exemple et autre dans doxigene, je veux bien être tenu au courant ;)



                      Sa sera pas pour demain (pas de projet en cour actuellement) Mais si ta demande porte sur le long terme (+ d'un mois) alors oki je note ;)



                      disons que ça ne ma demande porte sur la durée de mon exercice du PHP. donc il doit me rester a peu près 45 ans à taffer la dedans, puis pour le plaisir après :D

                      donc oui, prends note :p
                      • Partager sur Facebook
                      • Partager sur Twitter

                      Générer la documentation

                      × Après avoir cliqué sur "Répondre" vous serez invité à vous connecter pour que votre message soit publié.
                      × Attention, ce sujet est très ancien. Le déterrer n'est pas forcément approprié. Nous te conseillons de créer un nouveau sujet pour poser ta question.
                      • Editeur
                      • Markdown