Documentation du code

Coller la source (ou télécharger un fichier jusqu'à 500Ko) et récupérer le même code avec des docstrings, des commentaires de typeware, et — en option — une référence README.md et API.md. Choisissez l'un des 5 styles de docstring (Google / NumPy / reST-Sphinx / JSDoc-TSDoc / plain) et 5 champs de sortie (docstrings seulement, +inline, +README, +API ref, pack complet).

Mintlify Writer est une extension gratuite de VSCode qui ne fait que des docstrings en ligne — pas de README, pas de API ref. DocuWriter.ai charge 19$/mo pour un changement de style illimité et des portes derrière les niveaux payés. Tabnine ajoute de courts résumés en ligne dans le cadre de son plan Pro 12$/mo. Free.ai fonctionne à travers la piscine quotidienne de jeton sans abonnement mensuel, prend en charge tous les 5 styles dans le niveau gratuit, et peut émettre une référence README + API complète dans un seul shot que les plugins IDE ne peuvent pas.

Non — l'invite système interdit de renommer, de réorganiser ou de modifier une logique. Seuls les docstrings et les commentaires sont ajoutés. La vue "Original" dans le panneau de résultats vous permet de confirmer en retournant; copier-coller la version documentée dans votre fichier en toute confiance.

Google pour les projets Python nouveaux en 2018+ (mkdocs / pdoc le rendent propre). NumPy pour Python scientifique (matplotlib, scikit-learn convention). reST/Sphinx pour les projets Python plus anciens déjà sur Sphinx autodoc. JSDoc/TSDoc pour JavaScript/TypeScript (travaille avec VSCode IntelliSense et TypeDoc).

Oui — choisissez "Docstrings + README.md" ou "Full pack" scope. Le README comprend le nom du projet, une ligne de balise, commande d'installation (pip / npm / cargo / go-get inféré à partir de la langue), 30 secondes de démarrage rapide, appel API clé, et un détenteur de licence.

La référence API (Markdown) énumère tous les symboles publics regroupés par fichier/classe avec signature, but, paramètres, retours, et un exemple d'appel — prêt à coller dans un dossier `docs/`, ReadTheDocs, ou un site GitHub Pages. Les docstrings en ligne vivent dans le code lui-même. Choisissez "Full pack" pour obtenir les deux à la fois.

Qwen 3 Coder (par défaut, pool gratuit) gère ~95% des fichiers de moins de 200 lignes bien. DeepSeek R1 pour les fichiers où vous voulez un raisonnement profond sur les cas de bord le docstring doit mentionner. Premium Claude Sonnet 4 / GPT-5 pour la documentation de paquet entier fonctionne plus de 1000 lignes — ils tiennent plus de contexte et produisent un style plus cohérent à travers les fichiers.

Oui — lorsque "Ajouter info type" est coché, le modèle utilise des annotations de type existantes où présente et en déduit des types raisonnables d'utilisation où non. Les types inférés sont clairement placés dans la docstring (section Args / @param tag) de sorte qu'ils restent revisibles. Les annotations de code réelles ne sont pas ajoutées par Documentation du code — utilisez /code/refactor/ avec l'objectif "Type sécurité" pour cela.

Par appel, collez jusqu'à 12 000 caractères (~180 lignes). Pour les projets multi-fichier, lancez fichier par fichier (chaînez le même code à travers Documentation du code, puis cliquez sur « Générer des tests » pour obtenir des tests pour la version documentée). Ou utilisez l'API pour les tâches par lots — POST à /v1/chat/ dans une boucle.

Le code est envoyé au modèle, traité et jeté. Non stocké, non utilisé pour la formation. Pour un maximum de protection de la vie privée Qwen 3 Coder — auto-organisé sur nos GPU, votre code ne quitte jamais l'infrastructure Free.ai.

Python, JavaScript, TypeScript, Java, C++, C, C#, Go, Rust, Ruby, PHP, Swift, Kotlin, Shell/Bash, SQL, HTML/CSS — 16+ dans le sélecteur, avec détection automatique pour tout ce que le modèle reconnaît (Lua, Elixir, Haskell, Scala, Dart, R, MATLAB, Perl).

Oui — POST to /v1/chat/ with the documentation system prompt (style + scope + extras) and the code as the user message. Utile pour brancher la documentation dans une étape CI ou un crochet pré-commit. Voir /api/ for snippets.