User Tools

Site Tools


documentation_de_code

Documentation de code

Dans un projet informatique, il existe un certain nombre de documentation (répértoriées ici.

Pour la doc technique, il est possible de documenter automatiquement à partir de commentaires insérés dans le code. Les logiciels qui réalisent cette tâche sont appelés générateurs de documentation.

En sus de cette documentation automatique, il existe des outils pour générer de la documentation de façon moins automatique mais plus dédiée. Par exemple, la documentation de python est générée grâce à Sphinx, une chaine éditoriale spécialisée dans la documentation de code python et qui produit des documents pdf, html et plain text à partir d'un document formaté en reStructuredText.

Générateur de documentation python

  • pyDoc
  • Doxygen

Générateur de documentation java

  • javaDoc
documentation_de_code.txt · Last modified: 2010/02/28 20:41 by ginko