Comprenez n'importe quel code avec une explication claire et pédagogique

    Certains bouts de code sont obscurs, complexes, ou simplement mal documentés. Ce prompt vous aide à les rendre lisibles, compréhensibles et pédagogiques. Idéal pour l'onboarding d'un nouveau développeur, la relecture de code legacy ou simplement pour apprendre en décortiquant.

    Quand utiliser ce prompt

    En phase d'audit ou refacto

    Pour comprendre une lib ou un snippet externe

    Lors de l'onboarding d'un junior

    Pour créer une documentation rapide

    Ce que ce prompt permet d'obtenir

    Une explication ligne par ligne ou par bloc

    Des commentaires humains et clairs

    Une vulgarisation avec analogies si besoin

    Un résumé synthétique de la fonction du code

    Astuces et erreurs à éviter

    À faire

    • Adapter le niveau d'explication à la cible (débutant ≠ CTO)
    • Ajouter le contexte si le code est "isolé" d'un projet
    • Limiter la longueur pour des résultats lisibles

    À éviter

    • Bien préciser le langage (GPT peut se tromper sinon)

    Modèle de prompt

    Voici le modèle de base avec des espaces réservés. Remplacez les espaces réservés par vos informations spécifiques :

    Tu es un expert développeur et pédagogue. Analyse et explique clairement ce code : {{code_block}}. Langage utilisé : {{language}}. Le public visé est : {{audience_level}}. Fais une explication ligne par ligne ou par bloc logique, avec des commentaires clairs, analogies si utiles, et résumé final de ce que fait ce code. {{additional_context_block}}

    Descriptions des espaces réservés :

    {{code_block}}Code à expliquer - ex : function processData(input) { ... }
    {{language}}Langage de programmation - ex : JavaScript, Python, Go, Rust
    {{audience_level}}Niveau du lecteur cible
    {{additional_context}}Contexte ou contrainte (optionnel) - ex : le code fait partie d'une API REST, s'intègre dans une app React, ou doit être rendu accessible pour onboarding

    Exemple de prompt généré

    Voici un exemple avec des valeurs remplies :

    Tu es un expert développeur et pédagogue. Analyse et explique clairement ce code :
    
    function processData(input) {  
      const lines = input.split('\n');  
      const result = lines.map(line => line.trim()).filter(Boolean);  
      return result;  
    }  
    
    Langage utilisé : JavaScript. Le public visé est : débutant. Fais une explication ligne par ligne ou par bloc logique, avec des commentaires clairs, analogies si utiles, et résumé final de ce que fait ce code.

    Partager ce prompt

    Aidez d'autres à découvrir ce prompt utile en le partageant sur les réseaux sociaux