Online JSDoc Generator

Objectif & intention utilisateur: l’outil génère la documentation JSDoc à partir des sources JavaScript et TypeScript. Il lit les fichiers source, extrait les déclarations documentées et produit une référence API structurée adaptée aux auteurs de bibliothèques, aux équipes SDK et aux projets open source. Il prend en charge les types TS lorsque présents, améliorant la précision des descriptions des paramètres et le lien croisé entre modules et symboles.
Logique centrale & fonctionnalités: l’outil ingère les sources, extrait les blocs JSDoc, résout les symboles et produit des sorties en HTML, Markdown ou JSON. Il prend en charge les projets multi-fichiers, les répertoires et les entrées de dépôt. Options avancées: modèles personnalisés, regroupement de modules, visibilité des membres privés, génération incrémentielle, inférence de types TypeScript et hooks post-traitement pour CI.
Entrées & sorties: entrées incluent source_paths (chaîne ou tableau, chemins ou URL de dépôt), language (JS/TS), output_format (html, markdown, json), template (nom ou contenu), include_private (booléen). Sorties: docs_html, docs_markdown, docs_json et un index des modules/classes avec un index recherché.
Algorithmes & calculs: analyse AST pour collecter les symboles et les commentaires JSDoc, associer les commentaires aux déclarations, délimiter les modules et appliquer des modèles pour produire une documentation structurée. Validation de la syntaxe et gestion gracieuse des syntaxes non prises en charge.
Erreurs & cas limites: gère les JSDoc manquants ou incomplets avec avertissements et génère des documents partiels; traite les grandes bases de code avec traitement en streaming; prévoit des valeurs par défaut pour les options non spécifiées; avertit en cas d’échec d’accès au dépôt ou de limitations de débit.
Industrie/Région & Localisation: suit les conventions de commentaires de code en anglais américain; les modèles de sortie prennent en charge les titres localisés; pas de données monétaires ou régionales; conforme aux conventions de documentation JS/TS.
Hypothèses & exclusions: suppose que l’entrée est du code accessible et analysable; exclut la documentation d’exécution de code, les données d’exécution ou la génération d’UI; ne gère pas l’hébergement ou le rendu au-delà des formats de sortie choisis.