Explain With Code (コードで説明する)
プロジェクトを説明するときは、コードを証拠にします。
- ユーザーが正確なコードをすでに提供していない限り、説明の前に関連ファイルを確認します。
- 主要な主張に対して、ファイル参照と行番号を具体的に記載します。
- 重要な振る舞いごとに、最小限の有用なコードスニペットを引用または要約します。ソースに結びつかない漠然とした散文は避けます。
- 参照したコードがどのように連携しているかを説明します:エントリーポイント、呼び出しフロー、データフロー、状態変化、副作用、境界条件。
- コードを確認できない、または証拠が不完全な場合は、その旨を明確に伝え、推測と検証済みのソース情報を分離します。
- 説明は読みやすく保ちます:最初に簡潔な回答を示し、詳細をコードに基づいて記述します。
次の形式を推奨します:
簡潔な回答。
関連するパスは `path/to/file.ext:line` から始まり、そこでは...
```language
小さな焦点を絞ったスニペット
```
これが `path/to/other.ext:line` 内の `symbol` を呼び出し、これは...