Catégories

← View All Tools

Extracteur de Docstrings

Extrait et analyse la documentation du code source JavaScript/TypeScript, Python et Java

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

Inclure les commentaires de documentation originaux complets

Points clés

Catégorie
Development
Types d’entrée
textarea, select, checkbox
Type de sortie
json
Couverture des échantillons
4
API disponible
Yes

Vue d’ensemble

L'Extracteur de Docstrings est un outil puissant conçu pour analyser et extraire automatiquement la documentation technique intégrée dans votre code source JavaScript, TypeScript, Python et Java.

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.

Comment ça marche

  • •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.

Exemples

1. Extraction de documentation Python

Développeur Backend
Contexte
Un développeur doit documenter une bibliothèque de traitement de données utilisant des docstrings Python.
Problème
Extraire rapidement les arguments et les types de retour pour générer un fichier de configuration de documentation.
Comment l’utiliser
Coller le code Python dans l'outil et laisser la détection automatique identifier le format.
Résultat
Un JSON structuré listant chaque fonction, ses paramètres typés et ses exceptions, prêt à être importé dans un générateur de site statique.

2. Audit de documentation JSDoc

Lead Developer
Contexte
Le Lead Developer souhaite vérifier si toutes les fonctions publiques d'un projet TypeScript sont correctement documentées.
Problème
Identifier les fonctions manquantes de balises @param ou @return.
Comment l’utiliser
Soumettre les fichiers sources et analyser le JSON de sortie pour compter les occurrences des balises de documentation.
Résultat
Un rapport clair identifiant les zones du code nécessitant une mise à jour de la documentation.

Tester avec des échantillons

text
Exemples d'Extracteur de Liens Markdown
Documents Markdown d'échantillon avec divers types de liens pour tester l'outil d'extraction de liens Markdown
title token extractor
text
Échantillons d'Extracteur de Journal des Changements
Différents formats de journaux des changements pour tester les outils d'analyse et d'extraction
title token extractor
text
Exemples d'Extracteur de Numéros de Téléphone
Collection de texte mixte contenant des numéros de téléphone de divers pays pour les tests d'extraction
title token extractor
text
Échantillons de Documentation de Code
Exemples de code avec différents styles de documentation, y compris JSDoc, JavaDoc, docstrings Python et annotations TypeScript
matched family text
text

Hubs associés

Outils Text pour Convert
Découvrez 80 outils text pour des workflows de convert et comparez rapidement des utilitaires proches.
Outils Text
Découvrez 33 outils text pour des workflows de utility et comparez rapidement des utilitaires proches.
Outils Text pour Analyze
Découvrez 12 outils text pour des workflows de analyze et comparez rapidement des utilitaires proches.
Outils Text pour Format
Découvrez 9 outils text pour des workflows de format et comparez rapidement des utilitaires proches.

FAQ

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.

Documentation de l'API

Point de terminaison de la requête

POST /fr/api/tools/docstring-extractor

Paramètres de la requête

Nom du paramètre Type Requis Description
codeInput textarea Oui -
languageHint select Non -
includeFullText checkbox Non Inclure les commentaires de documentation originaux complets

Format de réponse

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
Données JSON: Données JSON

Documentation de MCP

Ajoutez cet outil à votre configuration de serveur MCP: 

{
  "mcpServers": {
    "elysiatools-docstring-extractor": {
      "name": "docstring-extractor",
      "description": "Extrait et analyse la documentation du code source JavaScript/TypeScript, Python et Java",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=docstring-extractor",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Vous pouvez chaîner plusieurs outils, par ex.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, max 20 outils.

Si vous rencontrez des problèmes, veuillez nous contacter à [email protected]