Documentation de projet

Bonjour,

Je recherche un logiciel pour documenter un projet informatique C++.

Ce que je cherche, c’est d’écrire un document qui récapitule l’architecture du code, le rôle des classes et le lien entre elles et avec des liens vers le code source en question.

Par exemple

Pour réaliser la fonction X, les classes A,B et C sont utilisées. La fonction A::f est le point d’entre pour cela. Ses deux arguments sont respectivement B et C. Pour construire un C, vous pouvez utiliser C::z.

Le but final c’est de générer un document qui synthétise l’architecture du programme, les concepts qu’il manipule, le flux d’information au sein du programme de sorte qu’on puisse lire ce document pour avoir une vue globale avant de plonger dans le code. Il me parait important que le logiciel soit aussi capable de detecter les changements de code pour signifier que la doc doit être p-e etre mise a jour.

Ce que je ne cherche pas:

• A documenter précisément les fonctions et méthodes une a une
• Avoir la doc mélangée avec le code

Si vous connaissez le nom d’un logiciel, je suis preneur.

D’après ce que j’ai lu quand j’ai fais des recherches pour documenter un de mes projets (en js). Pour le C++ la référence est Doxygen.

Il faudra que tu documentes ton code comme ceci.

Lis le sujet :

Donc c’est pas vraiment ce que souhaite @Davidbrcz.

Après, Doxygen génère quand-même une doc si on met pas de commentaire, et y a peut être moyen de le configurer pour qu' il te sorte ce que tu veux.

On ne peut pas configurer l’éditeur/IDE pour cacher les commentaires automatiquement ?

Il y a peut-être Sphinx, très courant dans le monde Python, qui fonctionne avec des fichiers rst indépendants du code.

Il est tout à fait possible de mettre la doc doxygen en dehors du code (dans des .dox de mémoire).

Il est tout à fait possible de faire des graphes, des modules et ne pas documenter les fonctions une à une avec doxygen aussi.

Sinon sphynx/pandoc est assez courant pour ça, mais il faudrait que tu précises ce que tu veux exactement.

Je connais Doxygen mais je l’avais écarté d’emblée car la doc me semblait trop centree sur classe / fonction / paramétré & a placer dans le code source alors que je cherche a documenter est plus une vision haut niveau.

La remarque de gbdivers sur les commentaires hors source m’a fait rafraîchir ma vision de doxygen. Y’a un support markdown (c’est deja ca), un support par dossier et la notion de module soulevee par unidan,

J’ai aussi decouvert qdoc au passage.

Je devrais pouvoir me débrouiller avec ca.

Merci !