ForHosting KIT · Ferramentas para dev

Documentação de código

Este serviço documenta código automaticamente: você envia o arquivo-fonte pela API e recebe docstrings, comentários e uma descrição do que cada função faz. Serve para quem herdou um projeto sem documentação e precisa entender — ou entregar — o código com explicações claras, sem passar dias escrevendo tudo à mão.

● Estávelpor 1.000 palavrasUS$ 0,003

Executar — US$ 0,003 + US$ 0,0135/1.000 palavras Ver a API

Use pelo WebAPIE-mailApp em breveTelegram em breve

Rode online

Rode nos nossos servidores com a sua conta. As ferramentas grátis rodam no seu navegador; esta aqui é descontada do seu saldo do KIT pelo preço acima.

O que sai do outro lado

Você envia o código e recebe uma versão documentada: docstrings nas funções e classes, comentários nos trechos menos óbvios e um resumo geral do arquivo. O texto explica o que o código faz e por quê — sem repetir o óbvio linha por linha. O resultado vem no padrão de comentário da linguagem enviada: JSDoc para JavaScript, docstring para Python, e assim por diante. Você revisa, ajusta o que quiser e faz o commit.

Como funciona a chamada

O fluxo é assíncrono: você faz um POST para /dev/code-document com o código no corpo da requisição e recebe um task_id na hora. Depois, consulta o resultado com esse identificador. Isso evita timeout em arquivos maiores e deixa o processo fácil de encaixar em um script de CI ou em uma rotina interna do seu time. Não tem painel para configurar nem cadastro para fazer: é uma chamada HTTP, uma resposta em JSON e pronto.

Quanto custa

O preço é publicado e por uso: US$ 0,003 por chamada, mais US$ 0,0135 por bloco de 1.000 palavras de código processado. Um arquivo de umas 2.000 palavras sai por cerca de US$ 0,03. Não existe mensalidade, franquia mínima nem surpresa no fim do mês: você paga exatamente o que usar, e o valor fica publicado na página — nada de “fale com nosso time comercial” para descobrir o preço.

Boas práticas antes de enviar

Remova segredos do código antes de mandar: chaves de API, senhas em variáveis, tokens de acesso. É boa prática com qualquer serviço online e leva um minuto. Também vale enviar arquivos coesos — um módulo por chamada gera documentação mais precisa do que o projeto inteiro colado de uma vez. Se o repositório é grande, divida por pasta e automatize as chamadas em lote com um script seu.

Casos de uso

Herdou um sistema sem documentação

A TecnoSul Soluções Digitais assumiu a manutenção de um sistema interno escrito há oito anos, sem um comentário sequer. Em vez de decifrar módulo por módulo, o time enviou os arquivos pela API e recebeu cada função explicada — a leitura do projeto caiu de semanas para dias.

Freelancer entregando projeto

Rafael Almeida Costa, dev freelancer em Curitiba, entrega o código documentado como parte do contrato. Antes de mandar o repositório para o cliente, ele roda os arquivos pela API e revisa as docstrings geradas. O cliente recebe um projeto legível — e ele fecha a entrega sem virar a noite escrevendo comentário.

Padronizar documentação no CI

Uma equipe que exige docstring em toda função nova pode chamar a API no pipeline: o script detecta funções sem documentação no pull request, gera a proposta de texto e comenta no próprio PR. O dev só revisa e aceita, em vez de escrever do zero.

Perguntas frequentes

Funciona com qual linguagem?

Com as linguagens comuns do dia a dia — JavaScript, TypeScript, Python, PHP, Java e afins — seguindo o padrão de comentário de cada uma. Se a sua linguagem é menos usual, faça um teste com um arquivo pequeno antes de processar o projeto inteiro.

A documentação vem em português?

Vem no idioma que você pedir na chamada, português incluído. A estrutura segue a convenção da linguagem (JSDoc, docstring), mas a explicação em si pode sair em português do Brasil, pronta para o time ler.

Quanto custa documentar um projeto inteiro?

A conta é linear: US$ 0,003 por chamada mais US$ 0,0135 por bloco de 1.000 palavras. Um projeto com 30.000 palavras de código fica em torno de US$ 0,45 — em dólares americanos, sem plano nem mensalidade.

Meu código fica salvo em algum servidor?

O fonte é enviado para processamento e usado para gerar o resultado da sua tarefa — nada dele é publicado nem aparece para outros usuários. Mesmo assim, siga a boa prática: tire chaves e senhas do código antes de enviar, como faria com qualquer serviço externo.

Como eu pago? Aceita Pix?

O pagamento é via PayPal, sem cadastro no site: a compra é direta. Pix ainda não — preferimos dizer isso com clareza a esconder no rodapé. O preço é sempre em dólares americanos (US$), publicado na página.

O resultado substitui a revisão humana?

Não. A documentação gerada é um ótimo rascunho, mas quem conhece a regra de negócio é você: revise antes de commitar, principalmente a explicação do porquê de cada decisão. O ganho está em partir de um texto pronto em vez da página em branco.

Para desenvolvedores — acesso via API

Tudo nesta página está disponível via API. Esta seção é para equipes que querem integrar a ferramenta aos próprios sistemas; quem não precisa disso pode simplesmente usar a ferramenta acima.

Endpoint

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

Autenticação por token Bearer. Um único POST coloca a tarefa na fila; o resultado chega por webhook ou link assinado.

Chame do seu código

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)

Exemplo de requisição

{
  "text": "…"
}

Exemplo de resposta

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

A API é assíncrona: cada chamada devolve um task_id na hora. Se preferir polling, consulte o status a até 1 requisição por segundo.

Preço

por chamadaUS$ 0,003

por 1.000 palavrasUS$ 0,0135

Preço publicado, sem tokens nem créditos escondidos. Tarefa que falha não é cobrada.

Erros

HTTP	Código	O que significa
`401`	`unauthorized`	Token ausente ou inválido. Confira o header Authorization.
`402`	`insufficient_balance`	Saldo insuficiente para esta tarefa. Faça uma recarga e tente de novo.
`404`	`unknown_type`	Esse tipo de tarefa não existe. Confira o campo type no catálogo.
`429`	`rate_limited`	Muitas requisições em pouco tempo. Espere um instante e tente de novo.
`422`	`task_failed`	A tarefa falhou do nosso lado. Você não paga nada por ela.

Ver a documentação completa do KIT →