explain-code

コードの解説

ユーザーが指定した範囲のコードを、短く読みやすい記事として解説します。網羅的な説明より、平易な文章と小さなコード例を優先してください。

デフォルト

• ユーザーが指定した範囲に厳密に合わせます。
• 次の構成にします：# のタイトル、📋 TLDR、その後に 1 つ以上の ## セクション。
• 各 ## セクションでは 1 つの考えを扱い、少なくとも 1 つのフェンス付きコードブロックを含めます。
• 文章はシンプルにし、コード例は小さく保ちます。
• 必要に応じてコードを簡略化しますが、動作には忠実であるようにします。
• コードやプロンプトで裏付けられない意図を作り上げないでください。

形式

# タイトル

トピックを示す、平易な英語の 1 行です。

📋 TLDR

コードを書いていない人にも要点が伝わる、短い文を 2～3 文書きます。

任意：全体の流れや受け渡しとして示すと理解しやすい場合に限り、小さな mermaid ブロックを 1 つ含めます。

📋 TLDR の後に、水平線 --- を追加します。

## セクション

各セクションでは、次のようにします。

1. 絵文字を少なくとも 1 つ含む、平易な英語の ## タイトルを書く。
2. 導入文を 1～2 文書く。
3. フェンス付きコードブロックを 1 つ示す。

コードブロックの後にセクションを続けないでください。

本文のセクション間には、水平線 --- を入れます。

文章

• 1 文につき、主な考えは 1 つにします。
• できるだけ短く、一般的な語を使います。
• まずシンプルな説明をし、その後に詳細を加えます。
• 長く込み入った文、説明のない専門用語、内輪の略語は避けます。

コード

• 現在のセクションの要点を説明するのに必要なコードだけを示します。
• 特に理由がなければ、空行を除いて約 10 行以内にします。
• 説明に役立たない部分は省きます。
• 要点が分かりやすくなる場合は、...、// ...、プレースホルダー、簡略化した識別子を使います。
• すべてのコード例に、要点となる行の意図を示す短いコメントを付けます。その行が何をしているのか、なぜ重要なのかを読者に伝えてください。
• コードをそのまま抜き出すより、動作に忠実な簡略例を優先します。

範囲が指定されていない場合

• ユーザーが範囲を指定しておらず、ステージングされていない変更がある場合は、ステージングされていない差分を対象とします。
• ユーザーが範囲を指定しておらず、ステージングされていない変更もない場合は、説明する対象を推測せず、説明してほしいファイル、差分、または領域を明示するようユーザーに尋ねます。

ガードレール

• 文章だけの ## セクションを作らないでください。
• セクションのコードブロックの後に、説明文を追加しないでください。
• プレースホルダーで同じ要点を伝えられる場合は、長いリテラル、シークレット、不透明なデータの塊を含めないでください。
• ユーザーから依頼がない限り、回答を行単位の書き起こしにしないでください。