コーディング規約に反している箇所を IntelliJ で一括修正する
検証環境
IntelliJ IDEA Ultimate 2023.1.3
IntelliJ のコードインスペクション機能
IntelliJ にはコードインスペクションという機能があります。
IntelliJ IDEA には、プロジェクトをコンパイルする前に、プロジェクト内の異常なコードを検出して修正する一連のコードインスペクションがあります。IDE は、さまざまな問題を見つけてハイライトし、デッドコードを見つけ、考えられるバグやスペルの問題を見つけ、全体的なコード構造を改善することができます。
タイポや不要な変数定義など、改善できる箇所をハイライトや一覧で表示し、修正することができます。
コーディング規約に反している箇所を IntelliJ で一括修正する
例えば、プロジェクトの途中で「インスタンスフィールドの参照時に this を付与する」というルールを定めたとします。既存のコードにルールに反したものがあれば、それらを一括で修正して一貫性を持たせたいです。
そんな時にコードインスペクションが役に立ちます。
まず、ルールに反しているコードを検出するためにインスペクションを設定します。設定
-> エディター
-> インスペクション
から設定できます。
この時、検出したい項目のみをチェックしたプロファイルを作っておくと、インスペクションの実行時間が短くなり、実行結果も見やすくなります。
次に、メニュー
-> コード
-> コードのインスペクション
からインスペクションを実行します。スコープをプロジェクト全体に、プロファイルは適当なものを選びます。
実行が完了すると、ツールウィンドウの問題タブに結果が表示されます。
結果をクリックし、提示された修正を行います。
以上の手順で一括で修正できます。
まとめ
開いているファイル内で問題があれば、波線やハイライトで示し、Alt(Option) + Enter
で修正できるのは知ってました。ふと複数ファイルでも同じように修正できないかな〜と思って、IntelliJ を触ってたらできたので、ご紹介しました。
新たにルールを定めた後の一括修正時にコードインスペクションを使ってみてください。
私たち BABY JOB は、子育てを取り巻く社会のあり方を変え、「すべての人が子育てを楽しいと思える社会」の実現を目指すスタートアップ企業です。圧倒的なぬくもりと当事者意識をもって、こどもと向き合う時間、そして心のゆとりが生まれるサービスを創出します。baby-job.co.jp/
Discussion