リンターを使って、潜在的なエラー、スタイル違反、ベスト プラクティスからの逸脱がコードにないか確認することをお勧めします。 リンターは、バグを早期に検出し、コードの読みやすさを改良し、コードの一貫性と保守性を確保するのに役立ちます。
サンプル シナリオ
コードに対してリンターを実行したところ、修正が必要な issue がいくつか特定されました。 これらを手動で修正するのではなく、Copilot Chat に修正を依頼できます。
プロンプトの例
-
エディターですべてのコードを選び、次のように入力します。
Fix the lint errors -
PEP8 for Python など、言語用に特定のコーディング ガイドライン セットを指定できます。
Use PEP8 to fix the lint errors -
コーディング規約と規則を定義するローカル ファイルがある場合は、そのファイルをチャット ウィンドウにドラッグして添付ファイルとして追加し、次のように入力します。
Use the attached style guide to fix the lint errors -
または、Copilot Chat に、特定の種類の lint エラーのみを修正するように依頼することもできます。
Make sure all functions use snake_case naming style
応答の例
Copilot は、変更する必要がある点を示し、修正されたコードを提供します。 提案されたコードは、十分に確認してから使ってください。 Copilot から提案されたコードでは、リンターによって特定されたすべての issue が解決されるとは限らないため、提案されたコードを使う場合は、常にリンターを再度実行する必要があります。
Copilot を使って修正できるリンティングの issue には、次のようなものがあります。
- 不足している必要なインポートを追加する。
- コード内で使われていないインポートを削除する。
- import ステートメントを別の行に分割する。
- スタイル ガイドラインに従ってメソッドと関数の名前を使う。
- 演算子の前後にスペースを追加する。
- 一貫性のあるインデントを確保する。
- 末尾の空白を削除する。
- 単一行にある複数のステートメントを別の行に分割する。
- 長い行を複数行に分割する。
- 使用されていない変数を削除する。
- スタイル ガイドラインに準拠するために空白行を追加または削除する。
- 関数、クラス、モジュールに docstring を追加する。
- 今後実行されることがないコードを削除する。
- 関数内のすべての return ステートメントが値を返すか、何も返さないことを確認する。
- グローバル変数の使用を減らすか排除する。
- 正しい数値と型の引数を使って関数が呼び出されていることを確認する。
- コメントが正しく配置され、意味があることを確認する。
- print ステートメントを適切なログに置き換える。