コードスニペットの説明またはレビューのために提出するには？
応答でコードの観察と実行の結論を区別するためにスコープを絞り込みます。
コードのスコープを制限する
まず、レビュー対象の関数または関連スニペットを提供し、言語、呼び出し方法、および期待される動作を指定してください。問題が構成、入力形式、または他の関数に依存する場合は、最小限必要なコンテキストを含めてください。応答がプロジェクト全体の一般的なチェックリストに拡大するのを避けるために、制御フロー、境界条件、または回避すべき潜在的な問題のいずれを理解したいのかを明確に述べてください。
具体的なレビュー目標を提供する
「この関数が空の入力をどのように処理するか説明し、テストが必要な境界ケースを指摘してください。」と書くことができます。修正の提案が必要な場合は、その理由と期待される影響の説明をリクエストしてください。コードを直接貼り付ける場合や、利用可能な添付ファイル経由で提供する場合、常にインデントとファイル名を確認してください。便宜のために、実際のキーやシークレットを資料に含めないでください。
- 関連するコード、言語、および期待される結果を提供します。
- 実際の結果または最も懸念されるリスクを説明します。
- 発見事項、提案、および検証方法を別々にリストするようにリクエストします。
完了したレビュー手順を確認する
コードを読むことからのみ導き出された結論は静的分析であり、テストが実行されたことを意味しません。応答がプログラムが実行されたと主張する場合は、対応するツールの出力を確認してください。環境が利用できない場合は、検証されていない部分のリストを要求してください。修正を採用する前に、特に通常の入力とエラー処理の両方が期待どおりであることを確認して、適切な環境で動作をチェックする必要があります。