# Extracteur de Docstrings Extrait et analyse la documentation du code source JavaScript/TypeScript, Python et Java > Page canonique: https://elysiatools.com/fr/tools/docstring-extractor - **Catégorie:** Development - **Mots-clés:** documentation, docstring, jsdoc, javadoc, python, javascript, typescript, java, analyseur, commentaires ## Présentation ## Fonctionnalités Extrait la documentation de plusieurs langages de programmation : - **JSDoc** : Commentaires de documentation JavaScript et TypeScript - **Docstrings Python** : Documentation de fonctions et classes en triples guillemets - **JavaDoc** : Commentaires de documentation Java avec balises standard ## Extraction Extrait les métadonnées complètes de documentation : - **Noms de fonctions/classes** : Identifiants de symboles - **Descriptions** : Texte principal de la documentation - **Paramètres** : Balises @param avec noms, types et descriptions - **Valeurs de retour** : Balises @return ou @returns - **Exceptions** : Balises @throws, @exception ou sections raises - **Exemples** : Balises @example ou blocs de code d'exemple - **Numéros de ligne** : Emplacement dans le code source - **Visibilité** : Membres publics, privés ou protégés ## Analyse Analyse les modèles de documentation courants : - JSDoc : `/** ... */` avec @param, @return, @throws - Python : `"""..."""` avec sections Args, Returns, Raises - JavaDoc : `/** ... */` avec @param, @return, @throws ## Index Génère un index de documentation searchable : - Noms de symboles pour recherche rapide - Catégorisation par type (fonctions, classes, méthodes) - Mesures de complétude de documentation - Comptage des exemples, paramètres et types de retour ## Entrées - **Code Source** (textarea): Collez votre code source ici pour extraire la documentation... - **Langage de Programmation** (select) - **Inclure le Texte Complet de la Documentation** (checkbox): Inclure les commentaires de documentation originaux complets ## Quand l'utiliser - Générer automatiquement une documentation technique à partir des commentaires de votre code. - Auditer la complétude de la documentation au sein d'un projet de développement. - Extraire des métadonnées structurées pour alimenter des portails de documentation ou des outils de recherche. ## Fonctionnement - Collez votre code source dans la zone de texte prévue à cet effet. - Sélectionnez le langage de programmation ou laissez l'outil le détecter automatiquement. - Lancez l'extraction pour obtenir un fichier JSON structuré contenant les fonctions, classes, paramètres et exemples trouvés. ## Cas d'usage - Création automatique de pages de référence API pour les bibliothèques open-source. - Analyse de la dette technique liée au manque de documentation dans les bases de code legacy. - Génération d'index de recherche pour faciliter la navigation dans de grands projets logiciels. ## Questions fréquentes ### Quels langages sont supportés ? L'outil supporte nativement JavaScript, TypeScript, Python et Java. ### Quelles informations sont extraites ? L'outil extrait les noms des symboles, les descriptions, les paramètres (@param), les valeurs de retour, les exceptions et les exemples de code. ### L'outil peut-il analyser des commentaires JSDoc ? Oui, il analyse parfaitement les blocs JSDoc standards (/** ... */) utilisés en JavaScript et TypeScript. ### Est-il possible de conserver le texte original des commentaires ? Oui, en activant l'option 'Inclure le Texte Complet', vous pouvez récupérer les commentaires bruts en plus des métadonnées structurées. ### Quel est le format de sortie ? Les résultats sont fournis sous forme de JSON structuré, facilitant leur intégration dans d'autres systèmes ou outils. ## Outils associés - [Extracteur de Journal des Modifications](https://elysiatools.com/fr/tools/changelog-extractor): Analyse et extrait des données structurées de journaux des modifications et de notes de version dans plusieurs formats - [Analyseur de User Agent](https://elysiatools.com/fr/tools/new-user-agent-parser): Analyse les chaînes User Agent pour extraire les informations du navigateur, SE, appareil et moteur - [Extracteur de Paramètres URL](https://elysiatools.com/fr/tools/url-parameter-extractor): Extraire et analyser les paramètres des URLs incluant les chaînes de requête, fragments de hash et segments de chemin - [Analyseur User-Agent](https://elysiatools.com/fr/tools/user-agent-parser): Analyse les chaînes User-Agent pour extraire des informations sur le navigateur, le système d'exploitation, l'appareil et le moteur - [Extracteur d'Emails en Vrac](https://elysiatools.com/fr/tools/bulk-email-extractor): Extrayez toutes les adresses e-mail du texte saisi, des articles, du code source Web ou de contenu mixte. Prend en charge la déduplication et l'exportation vers JSON. - [Extracteur de Dates](https://elysiatools.com/fr/tools/date-extractor): Extrait les dates du texte dans plusieurs formats dont chinois, ISO et américain avec analyse détaillée - [Désobfuscateur JavaScript](https://elysiatools.com/fr/tools/javascript-deobfuscator): Désobfusque et analyse le code JavaScript obscurci pour améliorer la lisibilité et la compréhension - [Extracteur d'Attributs HTML](https://elysiatools.com/fr/tools/html-attribute-extractor): Extrait les attributs spécifiés (href, src, data-*, etc.) du contenu HTML avec prise en charge du filtrage par nom de balise ## Exemples - [Échantillons d'Extracteur de Journal des Changements](https://elysiatools.com/fr/samples/changelog-extractor): Différents formats de journaux des changements pour tester les outils d'analyse et d'extraction - [Exemples d'Extracteur de Liens Markdown](https://elysiatools.com/fr/samples/markdown-with-links): Documents Markdown d'échantillon avec divers types de liens pour tester l'outil d'extraction de liens Markdown - [Exemples d'Extracteur de Numéros de Téléphone](https://elysiatools.com/fr/samples/phone-number-extractor): Collection de texte mixte contenant des numéros de téléphone de divers pays pour les tests d'extraction - [Exemples de Traitement d'Images Web Python](https://elysiatools.com/fr/samples/web-image-processing-python): Exemples de traitement d'images Web Python utilisant PIL/Pillow incluant la lecture, l'enregistrement, le redimensionnement et la conversion de format ## Contenu associé - [Outils de Redaction, d Extraction et de Publication de Documentation](https://elysiatools.com/fr/hubs/documentation-authoring-publishing): Redigez de la documentation, extrayez du contenu depuis le code ou des PDF, revisez du Markdown et exportez des documents soignes dans un seul hub. - [Outils de conversion de casse, d’encodage et de normalisation de texte](https://elysiatools.com/fr/hubs/text-convert): Comparez les outils de conversion de casse, de largeur de caractères, d’encodage, de quoted-printable et de normalisation de texte dans un hub unique. - [Outils Text](https://elysiatools.com/fr/hubs/text-utility): Découvrez 33 outils text pour des workflows de utility et comparez rapidement des utilitaires proches. - [Outils d’analyse de texte, de lisibilité et d’inspection de contenu](https://elysiatools.com/fr/hubs/text-analyze): Comparez statistiques de texte, détection de langue, score de lisibilité, analyse de sentiment, revue de modération et analyse de motifs dans un hub unique.