コードの整形と再配置
GoLand を使用すると、現在の コードスタイルスキーム または .editorconfig ファイルで指定した要件に従ってコードを整形できます。 .editorconfig で定義されていないものがあれば、プロジェクト設定から取得されます。
コードの一部、ファイル全体、ファイルのグループ、ディレクトリ、モジュールを整形できます。 また、コードの一部や一部のファイルを再フォーマットから除外することもできます。
コード箇所を整形する
エディターで、整形したいコード箇所を選択します。
再フォーマットする前に、選択したコードに適用されているコードスタイル設定を確認できます。 Alt+Enter を押して、 コードスタイルの設定を調整する をクリックします。
メインメニューで、 に移動するか、 Ctrl+Alt+L を押します。
または、表示される ツールバーで、
コードの整形 をクリックします。
ファイルを再フォーマットする
ファイルをエディターで開いて Ctrl+Alt+Shift+L を押すか、 プロジェクト ツールウィンドウでファイルを右クリックして を選択します。
開いた ファイルの整形 ダイアログで、必要に応じて次の整形オプションを選択します：
インポートの最適化: 未使用のインポートを削除する、足りないものを追加する、インポート文を整理するには、このオプションを選択します。
コードのクリーンアップ: コードクリーンアップインスペクションを実行するには、このオプションを選択します。
改行を保持しない ：コードスタイル設定に従って改行を整形します。 このオプションは、現在の言語で が で有効化されている場合にのみ使用できます。 改行を保持しない を選択すると、IDE は一時的にその設定をオーバーライドし、現在のコードスタイルに従って既存の改行を削除します。
カスタム改行を削除するために再度整形 オプションを で使用することもできます。
実行 をクリックしてください。
再フォーマット中にコードに加えられた正確な変更を確認するには、 ローカル履歴機能を使用します。
行インデントを整形する
指定した設定に基づいて行のインデントを整形できます。
エディター内で必要なコード箇所を選択し、 Ctrl+Alt+I を押します。
インデント設定を調整する必要がある場合は、 設定 ダイアログ (Ctrl+Alt+S) で に進みます。 インデントを変更する言語を選択します。
タブとインデント タブで、適切なインデントオプションを指定し、 OK をクリックします。
保存時にコードを自動的に整形する
IDE で、 保存時に変更されたファイルのコードを自動的に整形するように設定できます。
Ctrl+Alt+S を押して設定を開き、 を選択します。
コードの整形 オプションを有効化します。
さらに、IDE でコードを整形する方法を設定できます：
スコープを構成… をクリックして、 再フォーマットから除外するファイル名やディレクトリのパターンを指定します。
すべてのファイルタイプ リストから、コードを整形するファイルのタイプを選択します。
プロジェクトがバージョン管理下にある場合は、 ファイル全体 または 変更された行 を選択します。
変更された行 を選択した場合、再フォーマットはローカルで変更されたがまだリポジトリにチェックインされていないコード行のみ適用されます。
コミット時にコードを整形する
プロジェクトが バージョン管理下にある場合、リポジトリへ変更をコミットする際にコードを自動的に整形できます。 この場合、追加または変更されたコードのみが再フォーマットされます。
Alt+0 を押して コミット ツールウィンドウを開き、 コミットオプションを表示
をクリックします。コミットチェック メニューで、 コードの整形 オプションを有効にします。
オプションを有効化した後、コミットするたびに追加または変更されたコードが整形されます。
整形からファイルを除外する
ファイルとディレクトリのグループを再フォーマットと インポートの最適化から除外できます。
設定 ダイアログ（Ctrl+Alt+S ）で に移動します。
フォーマッター タブに切り替え、 フォーマットしない フィールドに、 グロブパターン(英語)を使用して除外するファイルとディレクトリを入力します。
セミコロン
;で区切られた複数のグロブパターンを指定できます。
をクリックすると、フィールドが展開され、各パターンが別々の行に表示されます。変更を適用して、ダイアログを閉じます。
エディターでのコード箇所の整形から除外する
設定 ダイアログ（Ctrl+Alt+S ）で に移動します。
フォーマッター タブに切り替えて、 コードコメント内のマーカーでフォーマッターのオン / オフを切り替える オプションを有効にします。
エディターで、除外する領域の先頭に、行コメント Ctrl+/ を作成し、
@formatter:offと入力します。 領域の最後に、別の行コメントを作成し、@formatter :onと入力します。組み込みフォーマッターは、マーカー間のコードを変更せずに保持します。
gofmt ツールを使用した再フォーマット
デフォルトでは、Go ファイルを整形するときに、GoLand は組み込みフォーマッターを実行してから gofmt を実行します。 この二回目のパスを使用するには、 gofmt 実行可能ファイルを含む Go SDK を構成します。
組み込みフォーマッターは、選択したコードや構文エラーのあるコードをフォーマットできます。 gofmt ツールは標準の Go フォーマットをファイル全体に適用します。 選択範囲を整形するときは実行されません。
gofmt を個別に実行することもできます:
Go ツール: をクリックし、 Go fmt ファイル （現在のファイルで gofmt を実行する場合）または Go fmt プロジェクト （現在のプロジェクトで gofmt を実行する場合）を選択します。
コミットチェック では、 Go fmt（フォーマット） がデフォルトで選択されています。 コミットする前にこのフォーマット手順をスキップするには、選択を解除します。
整形後の gofmt を構成する
Ctrl+Alt+S を押して設定を開き、 を選択します。
その他 タブを開きます。
gofmt を実行 で、両方のフォーマッターを実行するには コードの再フォーマット時アクション を選択し、組み込みフォーマッターのみを使用するには選択を解除します。 このチェックボックスはデフォルトで選択されています。
コメントに先行スペースを設定する
コードの整形 アクション Ctrl+Alt+L を適用すると、GoLand はコメントテキストの前に先行スペースを追加する場合があります。
前 | 後 |
|---|---|
//easyjson:json
|
// easyjson:json
|
Go では、アノテーションもアノテーションとして使用されます。 一部のライブラリでは、アノテーションマーカーとアノテーション指示の間のスペースは正しく処理されません。 前の例では、 easyjson:json はアノテーションです。
特定の接頭辞で始まるアノテーションの先頭スペースを無効にすることができます。
設定 ウィンドウ（ ）を開きます。
をクリックしてください。
その他 タブをクリックします。
コメントの先頭にスペースを追加する チェックボックスを選択します。
次で始まるコメントを除く: で、 追加 アイコン (
) をクリックします。例外として追加する接頭辞の名前を入力します（たとえば、
easyjson）。
