開発のカテゴリへ戻る

開発用AIプロンプト

コード解説・ドキュメント自動生成:レガシーコード読み解き&仕様書作成

複雑なソースコードをAIが解析し、その動作を日本語で分かりやすく解説します。また、JSDocやPythonのdocstring、README用の仕様説明文も自動生成。コードレビューや引き継ぎの工数を劇的に削減します。

0

プロンプト本文(編集できます)

この編集内容はブラウザ内だけで使われ、保存はされません。

AI 出力

おすすめの利用場面

  • 他人が書いた複雑なコードの理解
  • 古いシステムの調査・リファクタリング準備
  • APIや関数のドキュメント(README)作成
  • 新人教育用のコード教材作成

使い方

  1. 1. プロンプトをコピーしてAIに貼り付けます。
  2. 2. 解析したいコードを貼り付けて実行します。
  3. 3. 解説を読み、必要に応じてドキュメント部分をプロジェクトに反映します。

入力例

解析対象:(ReactのuseEffectとAPI通信が絡む複雑な関数のコード)

出力イメージ

1. 概要:この関数はコンポーネントのマウント時にユーザー認証状態をチェックし、有効な場合はプロファイルデータを取得します。...