環境
- Windows
- PyCharm 2025.1.2
- JetBrains AI Assistant
基本機能
JetBrains AI Assistantには以下のような機能があります。
- AI chat
- コード補完
- コードの説明
- 問題点の発見と修正
- バージョン管理システムとの連携
- コミットメッセージの生成
- 競合の解決
- プルリクエストの概要の生成
- テストの生成
- ドキュメントの生成
- 別言語変換
- MCPサーバーを介した連携
Prompt Library
AI Assistantに対する指示を保存・管理できる機能です。
File > Settings の Prompt Library から設定できます。
Prompt Libraryでは下記のことができます。
- 定型文として繰り返し利用したいプロンプトの登録
- AI Assistantの一部のアクションをカスタマイズ
AI Assistantのカスタマイズの一例としては、コミットメッセージのフォーマット指定ができます。
IDE上での操作
エディタ上で、右クリック または ALT + Enterキー を押し、AI Actions を選択すると AI Assistantの機能を呼び出せます。
AI Actions のメニューからは下記のことができます。
- コード生成
- コードの説明
- リファクタの提案
- 問題点の発見
- 選択内容から新規AIチャットを開始
- ドキュメントの生成
- テストの生成
- 型ヒントの追加
エラーの説明・修正
実行時にエラーが出た場合、Explain with AI をクリックすると、エラーの原因を分析して改善方法を具体的に提案してくれます。
AI Assistant活用時に個人的に意識していること
以下はあくまで私個人の例です。
ベストプラクティスを示したものではない点をご了承ください。
Prompt Library をきちんと設定する
AI Assistant の能力を最大限に引き出すためにはカスタムプロンプトを適切に設定しておくことが効果的です。
例えば、docstringの記述スタイル (Google, NumPy, reStructuredTextなど)、テストコードのフレームワーク (pytest, unittestなど) の指定、コミットメッセージのフォーマットルール (Conventional Commitsなど) を事前に入力しておけば、求める回答に近いものを得られやすくなります。
AI Assistant に期待する作業・任せたい作業を明確にする
私個人のケースとしては下記に該当するタスクをAI Assistantにサポートさせています。
- 個人的に面倒だと感じる作業
- 現時点で伸ばしたいスキルとは異なる作業
具体的には下記のようなものです。
- docstringの記述 ->
Write Documentation - 型ヒントの記述 ->
Add Type Annotations - 他者が書いたコードのリーディング ->
Explain Code - エラー修正のための原因調査 ->
Explain with AI