ForHosting KIT · 開発者向けツール

ソースコードにドキュメントを自動生成

ソースコードを読み込み、関数やクラスが何をしているかを説明する文章としてまとめるツールです。コメントのないコードや、担当者が変わって仕様がわからなくなったコードの引き継ぎ資料づくりに使えます。

● 安定提供中1,000語あたり$0.003

ご利用方法ウェブAPIメールアプリ近日Telegram 近日

オンラインで実行

アカウントでログインし、当社のサーバー上で実行します。無料ツールはブラウザ内で動作しますが、これは上記の料金がKIT残高から差し引かれます。

対応する場面

受託開発やSES常駐の現場では、納期を優先してコメントを書く余裕がないままコードが完成することが少なくありません。担当者が異動や退職で入れ替わると、残されたコードだけが手がかりになります。この機能は、そうしたコードを読み込み、関数やクラスの役割を文章として書き出します。

出力される内容

各関数やクラスが何を受け取り、何を返すか、処理の大まかな流れを日本語の文章でまとめます。コード中にコメントが一切なくても実行できますが、変数名や関数名が具体的であるほど、説明の精度は上がります。

使い方

ドキュメント化したいコードを貼り付けて実行するだけです。ファイル単位でもクラス単位でも対応し、Webページから直接実行するほか、継続的インテグレーションの一部としてAPIから呼び出す使い方もできます。

料金の仕組み

料金は1回の実行につき$0.003（米ドル）、加えてコードの分量1,000語ごとに$0.0135です。3,000語程度のモジュールであれば、合計は$0.0435ほどになります。月額契約は必要ありません。

生成後に確認すること

出力される説明はコードの構造から読み取れる範囲にとどまり、設計の意図や社内独自のルールまでは推測できません。生成した文章はドキュメントの下書きとして使い、公開前に開発者本人が意図の部分を補うことをおすすめします。

活用例

退職者が残したコードの引き継ぎ

有限会社ささき印刷の情報システム担当者が退職した際、コメントのない社内ツールのコードにこの機能でドキュメントを付け、後任の田中大輔が仕様を把握する時間を短縮しました。

個人開発アプリの仕様整理

個人開発者の山本翔太は、半年前に書いたコードの仕様を忘れてしまい、この機能で関数ごとの説明を生成してから機能追加に着手しています。

受託案件の納品ドキュメント

合同会社みどりデザインでは、クライアントへの納品時に必要なドキュメントを、この機能で下書きしてから体裁を整えて提出しています。

よくある質問

送信したソースコードは保存されますか

ドキュメントを生成する処理にのみ使用し、処理後にサーバー側で保管され続けることはありません。未公開のコードでもご利用いただけます。

コードの分量に上限はありますか

固定の上限は設けていません。分量が多いほど1,000語あたりの料金が加算されるため、実行前に画面で概算金額をご確認いただけます。

生成された説明はそのままドキュメントとして公開できますか

下書きとしての精度は高いものの、設計の意図や社内独自のルールまでは読み取れません。公開前に開発者本人が確認・加筆することをおすすめします。

対応しているプログラミング言語は限られますか

特定の言語に限定していません。一般的な構文であれば、コメントの記法が異なる言語でも読み込んで説明を生成します。

料金はどのように計算されますか

1回の実行につき$0.003、コードの分量1,000語ごとに$0.0135が加算されます。米ドル建てで、月額契約は不要です。

日本語のサポートはありますか

日本語でのサポートは行っておりません。サポートは英語またはスペイン語で、担当者が直接対応します。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

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

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

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)

リクエスト例

{
  "text": "…"
}

レスポンス例

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

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.003

1,000語あたり$0.0135

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。
`422`	`task_failed`	タスクの処理に失敗しました。このタスクは課金されません。

KITの完全なドキュメントを見る →