Comprendre du code repris et générer sa documentation.
Le prompt
prompt · faire expliquer et documenter un bout de code
Voici un extrait de code en [langage] : ``` [colle ton code] ``` Fais ceci : 1. Explique en français, simplement, ce que fait ce code (vue d'ensemble puis étape par étape). 2. Signale les risques évidents (bugs potentiels, cas non gérés, sécurité). 3. Propose une version commentée et, si pertinent, une version plus lisible — sans changer le comportement. 4. Liste les questions que tu te poses si quelque chose est ambigu. N'invente pas le comportement de fonctions externes que tu ne connais pas : dis-le.
Copie-le, remplace tout ce qui est entre [crochets] par tes vraies infos, puis colle-le dans ton outil IA (ChatGPT, Claude, Gemini, Le Chat…).
Pour de meilleurs résultats
- Pour du code sensible, préfère un outil qui n'entraîne pas ses modèles sur tes données.
codedocumentationdev