Toutes les ressources premium et membres pour 8,99 €/mois, en abonnement sans engagement. Voir les offres

PalateKit

Se connecter
Menu

Demander une ressource

Décrivez en une phrase la ressource qui vous manque. Nous vous écrirons quand elle sera publiée.

0 / 280

Une page, une vidéo ou une image en ligne.

Débloquer PalateKit

Tout débloquer

Offre

Le paiement vaut acceptation de nos conditions générales de vente.

Paiement sécurisé par Stripe. Reçus et factures envoyés par e-mail.

Content de vous revoir

Connectez-vous pour installer, télécharger ou sauvegarder cette ressource. Un compte gratuit suffit pour les ressources gratuites.

Documentation du code : JSDoc, docstrings et commentaires v1.0.0

Utilisez cette ressource pour documenter des fonctions, classes et modules dans le code

Nouveau

  • 566 téléchargements
  • 221 mentions J'aime
  • 177 sauvegardes

Gratuit

Installer avec la CLI

Dans un terminal, depuis le dossier voulu :

npx --yes palatekit@latest install code-documentation-docstrings

Sans option, la skill va dans ~/.agents/skills/ ; ajoutez --agent claude-code (ou codex, cursor…) pour viser un agent.

Première fois : connectez la CLI avec

npx --yes palatekit@latest login

L'agent ajoute à votre code des commentaires de fonctions, de classes et de modules selon le standard du langage (JSDoc pour JavaScript et TypeScript, docstrings pour Python), avec des exemples d'usage et les définitions de types. Il ne commente que ce qui en a besoin.

Choisie surtout par

Mise à jour le 2 novembre 2026

Carte de la skill « Documentation du code : JSDoc, docstrings et commentaires »

Caractéristiques

Fonctionne dans
Guides d'installation
Génère avec
Le modèle de votre agent
Licence
MIT

Ressources similaires

Tout voir

Ce que vous obtenez

  • SKILL.md : règles de rédaction et contrôles de cohérence
  • references/ : modèles de documentation de fonctions, de classes, de modules et de types
  • templates/doc-template.md : gabarit de documentation

Pour qui

  • Votre base de code manque de documentation et l'équipe s'y perd
  • Vous voulez des docstrings cohérentes avant de générer une référence d'API

Pas pour qui

    Étiquettes

    • documentation
    • jsdoc
    • docstrings
    • code

    À propos

    Vous dites

    « Documente les fonctions du module de paiement en JSDoc, avec un exemple d'usage pour chacune. »

    Carte de la skill « Documentation du code : JSDoc, docstrings et commentaires »

    Skill publiée par aj-geddes sous licence MIT. Fichiers livrés dans leur version d'origine, en anglais.

    Voir plus

    Comment l'utiliser

    1. Installez la skill dans le dossier de skills de votre agent
    2. Demandez à votre agent de documenter des fonctions, classes et modules dans le code
    3. Relisez et ajustez le résultat

    Aperçu du contenu

    Fichiers

    • LICENSE1,1 Ko
    • NOTICE-PALATEKIT.md0,5 Ko
    • references/class-documentation-2.md2,6 Ko
    • references/class-documentation.md2,6 Ko
    • references/function-documentation-2.md1,9 Ko
    • references/function-documentation.md1,9 Ko
    • references/module-documentation.md1,4 Ko
    • references/type-definitions.md1,1 Ko
    • SKILL.md3,1 Ko
    • templates/doc-template.md0,4 Ko

    Origine et licence

    Référencée sans modification

    Auteur
    aj-geddes
    Source
    github.com/aj-geddes/useful-ai-prompts/tree/3f5182cfd739fc113f4af5244a1cf342ad7f7911/skills/code-documentation
    Licence
    MIT

    Notice

    « code-documentation » (aj-geddes, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    Avis des utilisateurs

    –

    Aucune note pour l'instant

    Chargement des avis…

    Supprimer votre avis ?

    Votre note et votre commentaire seront retirés de la fiche.