Utiliser l'IA pour générer documentation du code source : possible et pertienent ?

Bonjour,

Souvent quand je récupère du code open source, c'est très mal documenté.

Je me demandais s'il ne serait pas possible avec les IA+outils de générer cette documentation facilement.

Je me dis que demander à une IA de générer des commentaires d'entête pour chaque fonction pour ensuite passer le résultat à une application type doxygen, ça doit être quelque chose de réalisable.
Après là où j'ai un doute, c'est peut-on ensuite générer des diagrammes d'appel lorsque des pointeurs de fonctions dans des structures sont utilisés ?... j'ai l'impression que doxygen ne sais pas trop faire le lien entre les appels indirectes et d'organiser les fonctions par modules et couches (ce n'est peu-être pas fait pour ça ?)... après je ne suis pas un grand utilisateur de doygen, peut-être que je l'utilise mal.

Ensuite peut-on arriver à sortir un documentation architecturale (avoir une documentation macroscopique et pas uniquement une documentation de chaque fonction) ? Comment faire pour que la documentation explique comment initialiser et utiliser un module ?
Aussi avoir des exemples de code d’utilisation des différents modules/fonctions, ça serait le top.

Avez-vous déjà essayé ? Quels outils avez-vous utilisé et comment avez-vous fait ? Quel est votre retours d'expérience ?

Bonjour,

C'est en effet une question à se poser et je vous conseille d'essayer par vous même. Après, d'une part, l'IA ne fera qu'une "supposition", comme vous le feriez. Il va se repérer avec les noms des fonctions et des variables. Bien sûr, l'IA pourra "déduire" le comportement en lisant le code et bien sûr, ce sera plus rapide que la lecture du code par vous même, mais encore faut t-il faire confiance (ou être certain) du résultat que va donner l'IA.
Finalement, je pense que les commentaires seront plutôt génériques (et du coup, peu utiles).

Cela pourra donc être une aide, mais je doute que vous puissiez aller très loin.

C'est vrai qu'il faut arriver à lui faire confiance donc ça revient à relire et vérifier tout ce qui a été généré :?

Bonjour,

Les commentaires et explications d'un code ne sont pas la transcription du code. Auquel cas, ils ne serviraient à rien. Ils doivent éclairer sur l'intention du code (notamment pourquoi tel code moins lisible a été préféré, car supposé plus efficace) et sur l'algorithme implémenté.

Je pense que les IA actuelles devraient être capable d'identifier l'algorithme sous-jacent et de donner le rôle de chacune des parties du code dans cet algorithme. Cela suppose un algorithme classique et non une création nouvelle.

Pour les explications sur les choix d'écriture propres à chaque développeur, je serais plus incertain sur l'aptitude des IA à expliquer des choix qui ne sont peut-être pas aussi justifiés que le codeur le pensait.

Il ne reste qu'à tester sans oublier que la magie n'existe pas 8-)

Salutations