Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>gendocNew to Visual Studio Code? Get it now.
gendoc

gendoc

Tiavina Ramilison

|
4 installs
| (0) | Free
Extension vscode for automatic generate docs
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

DocGen – Générateur de documentation d’APIs Gemini pour VS Code

Extension VS Code pour générer automatiquement de la documentation d’APIs grâce à Gemini AI. La documentation est créée dans le dossier docs/ du projet, avec un nom de fichier parlant selon l’API détectée.


🚀 Fonctionnalités principales

  • Génération automatique de documentation pour les APIs uniquement (routes, endpoints, contrôleurs, etc.)
  • Détection automatique du type d’API dans la sélection
  • Création d’un fichier Markdown dans le dossier docs/ avec un nom explicite (ex : doc_getUser.md, doc_route_post_api_login.md)
  • Choix de la langue : Français ou Anglais
  • Utilisation simple via une seule commande

🛠️ Installation

  1. Téléchargez ou clonez ce dépôt :
    git clone https://github.com/Tiavina22/docgen.git
    
  2. Installez les dépendances :
    npm install
    
  3. Compilez l’extension :
    npm run compile
    
  4. Ouvrez le dossier dans VS Code et appuyez sur F5 pour lancer en mode développement.

🔑 Configuration de la clé API Gemini

L’extension nécessite une clé API Gemini valide pour fonctionner.

  1. Rendez-vous dans les paramètres de VS Code (Ctrl+, ou Cmd+,)
  2. Cherchez Gemini DocGen
  3. Renseignez votre clé API dans le champ "geminiDocgen.apiKey"
    • Vous pouvez aussi cliquer sur le bouton "Configurer la clé API" dans la sidebar de l’extension.

⚠️ Sans clé API, la génération sera désactivée et un message d’avertissement s’affichera.


✨ Utilisation rapide

  1. Sélectionnez le code d’une API (route, endpoint, contrôleur, etc.) dans l’éditeur
  2. Lancez la commande Générer documentation avec Gemini (Ctrl+Shift+P puis tapez le nom de la commande)
  3. Un fichier Markdown est créé automatiquement dans le dossier docs/ avec la documentation générée
  4. Le fichier s’ouvre automatiquement
  5. Si la sélection ne correspond pas à une API, aucun fichier n’est généré et un message d’avertissement s’affiche

� Exemple de résultat

Après génération, un fichier comme docs/doc_getUser.md ou docs/doc_route_post_api_login.md sera créé avec la documentation de l’API sélectionnée.


⚙️ Paramètres disponibles

Paramètre Description Valeurs possibles
geminiDocgen.apiKey Clé API Gemini (string)
geminiDocgen.language Langue de la documentation générée fr, en

❓ FAQ

Q : Où trouver ma clé API Gemini ? A : Sur le site officiel de Gemini (Google AI), dans votre espace développeur.

Q : L’extension ne génère rien, que faire ? A : Vérifiez que la clé API est bien renseignée dans les paramètres et que la sélection correspond à une API (route, endpoint, contrôleur, etc.).


🧑‍💻 Auteur

Développé par Tiavina Ramilison

GitHub : Tiavina22

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft