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
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]