Partage
  • Partager sur Facebook
  • Partager sur Twitter

Javadoc en python ? Comment le réaliser ?

Sujet résolu
    6 février 2011 à 11:29:35

    Bonjour,
    je viens de créer une petite classe de bufferisation en python et dans le but de m'entraîner à commenter, je l'ai donc commenté en utilisant la javadoc. Néanmoins, je me suis rapidement heurté au problème que les commentaires de type : /** * */ n'existe pas en python, je les ai donc modifié par des commentaires de la sorte : """ * """.
    Néanmoins, dans les deux cas, mon IDE (Geany), me montre rien des commentaires (que ce soit le début, ou les @return, @param et @see), j'aimerais donc savoir s'il existe une méthode bien spécial de documenter son code python... et surtout, que cette technique soit reconnue par les IDE (Afin d'éviter d'avoir à me replonger dedans).
    Merci d'avance !
    • Partager sur Facebook
    • Partager sur Twitter
    Anonyme
      6 février 2011 à 11:53:30

      Oui, les docstring. ;)
      • Partager sur Facebook
      • Partager sur Twitter
        6 février 2011 à 13:17:07

        Merci ! Néanmoins, celle-ci semble moins puissant que la javadoc, je vais me renseigner !
        • Partager sur Facebook
        • Partager sur Twitter
          13 février 2011 à 13:25:00

          Citation : jb1993

          Merci ! Néanmoins, celle-ci semble moins puissant que la javadoc, je vais me renseigner !



          Tu peux générer automatiquement des tests unitaires à partir des exemples écrits dans la javadoc d'une fonction donnée, par exemple ?
          Avec les docstrings, en tout cas, oui, et nativement…
          • Partager sur Facebook
          • Partager sur Twitter
          Zeste de Savoir, le site qui en a dans le citron !

          Javadoc en python ? Comment le réaliser ?

          × 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