ForHosting KIT · Outils pour développeurs

Documenter son code

Cet outil rédige la documentation de votre code source : il lit une fonction, un module ou un fichier entier, puis produit docstrings, commentaires d’en-tête et descriptions de paramètres cohérents avec le comportement réel du code. Vous gardez la logique, il ajoute la couche explicative que personne n’a le temps d’écrire.

● Stablepar requête + par 1 000 mots$0.003

Lancer — $0.003 + $0.0135/1 000 mots Voir l’API

Utilisez-le depuis WebAPIE-mailApp bientôtTelegram bientôt

Exécuter en ligne

Exécutez cette tâche sur nos serveurs, avec votre compte. Les outils gratuits tournent dans votre navigateur ; celui-ci est facturé sur votre solde KIT au prix affiché ci-dessus.

Ce qu’il documente

L’outil décrit chaque fonction : son rôle, ses paramètres, sa valeur de retour et les erreurs qu’elle peut lever. Sur un fichier entier, il ajoute un commentaire d’en-tête qui résume l’intention du module. Le résultat suit les conventions de votre langage plutôt qu’un format maison, pour que la documentation s’intègre à vos outils habituels sans retouche lourde. Vous relisez une base cohérente au lieu de tout écrire à partir de rien.

Il lit le code, pas vos intentions

Soyons clairs : l’outil documente ce que le code fait, pas ce que vous vouliez qu’il fasse. Si une fonction est mal nommée ou porte un effet de bord caché, la documentation le reflétera fidèlement. C’est souvent révélateur, mais cela reste un brouillon à relire : vous y ajoutez le contexte métier, les cas particuliers connus et les avertissements qu’aucune analyse du code seul ne peut deviner.

Le style de votre équipe

Docstrings de style Google ou reST en Python, blocs JSDoc en JavaScript et TypeScript, commentaires XML en C# : l’outil s’adapte au format attendu par votre langage et par vos outils de génération de documentation. Vous choisissez aussi la langue de rédaction, français ou anglais, pour rester cohérent avec le reste de votre base de code et éviter un mélange qui gêne la lecture d’une équipe entière.

Depuis l’éditeur, pas seulement en API

La façon la plus simple d’essayer : collez votre code sur cette page et lisez le résultat. Pour documenter une base entière ou brancher l’outil sur votre intégration continue, l’API prend le relais, et d’autres canaux suivront. La documentation n’est plus une corvée de fin de projet : c’est une étape que vous déclenchez quand le code est encore frais dans votre tête, au moment où vous en comprenez le mieux l’intention.

Cas d’usage

Reprendre un projet hérité

Nadia récupère un module PHP sans un seul commentaire chez Studio Lumen SAS. Elle le passe dans l’outil, obtient des docstrings sur chaque fonction et comprend enfin le rôle de chacune avant d’y toucher.

Préparer une revue de code

Avant d’ouvrir sa pull request, Thomas documente les nouvelles fonctions : les relecteurs lisent des descriptions claires plutôt que de deviner l’intention à partir des seuls noms de variables.

Uniformiser une base existante

Une équipe hérite de fichiers documentés de dix façons différentes. En repassant tout au même format JSDoc, elle obtient une base cohérente que son générateur de documentation exploite sans erreur.

Questions fréquentes

Quels langages prend-il en charge ?

Les langages courants du développement web et applicatif : Python, JavaScript, TypeScript, PHP, Java, C#, Go et Ruby, entre autres. Le format de documentation produit suit la convention attendue par le langage détecté.

La documentation est-elle en français ou en anglais ?

Au choix. Vous indiquez la langue de rédaction ; l’usage veut souvent l’anglais dans le code, mais le français est parfaitement pris en charge pour un projet interne ou francophone.

L’outil modifie-t-il la logique de mon code ?

Non. Il ajoute des commentaires et des docstrings sans toucher aux instructions. Le comportement reste identique ; seule la couche explicative change.

Mon code est-il conservé sur vos serveurs ?

Votre code est transmis à nos serveurs le temps du traitement, puis n’est pas conservé ni journalisé au-delà. Nous ne le réutilisons pour aucun autre usage.

Combien coûte la documentation d’un fichier ?

$0.003 par appel, plus $0.0135 par tranche de 1 000 mots de code traités, en dollars US. Le tarif est affiché, sans abonnement.

Faut-il créer un compte ?

Non. Vous collez votre code et lancez le traitement directement. L’achat, pour un usage facturé, se fait en une fois, sans inscription préalable.

Pour les développeurs — accès API

Tout sur cette page est disponible par programmation. Cette section s'adresse aux équipes qui veulent l'intégrer à leurs systèmes ; les autres peuvent simplement utiliser l'outil ci-dessus.

Endpoint

POSThttps://api.kit.forhosting.com/dev/code-document

Authentification par jeton Bearer : un seul POST met la tâche en file d’attente, et le résultat vous parvient par webhook ou lien signé.

Appeler depuis votre stack

curl -X POST https://api.kit.forhosting.com/dev/code-document \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d &#39;{"text":"…"}'

const res = await fetch("https://api.kit.forhosting.com/dev/code-document", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "text": "…"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/code-document",
    headers={"Authorization": f"Bearer {os.environ[&#39;KIT_KEY']}"},
    json={
    "text": "…"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/code-document", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => &#39;{"text":"…"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"text":"…"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/code-document", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

Exemple de requête

{
  "text": "…"
}

Exemple de réponse

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.code_document",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

L’API est asynchrone : chaque appel renvoie un task_id immédiatement, puis vous interrogez l’état à raison d’une requête par seconde.

Tarifs

par requête$0.003

par 1 000 mots$0.0135

Le prix est publié, sans tokens ni crédits. Une tâche qui échoue n’est pas facturée.

Erreurs

HTTP	Code	Signification
`401`	`unauthorized`	Clé API absente ou invalide : vérifiez l’en-tête Authorization.
`402`	`insufficient_balance`	Solde insuffisant : rechargez votre compte pour lancer cette tâche.
`404`	`unknown_type`	Type de tâche inconnu : vérifiez le champ type de votre requête.
`429`	`rate_limited`	Trop de requêtes : ralentissez la cadence, puis réessayez.
`422`	`task_failed`	La tâche a échoué : elle ne vous est pas facturée.

Consulter la documentation complète du KIT →