2019.10.24

Visual Studio Code開発環境で役立つエクステンション機能について(その2)

  • このエントリーをはてなブックマークに追加
  • follow us in feedly

はじめに

前回に引き続き、今回もVisual Studio Codeでの開発を助けてくれるエクステンション機能をご紹介します。

今回はコーディング時に入れておくとちょっと便利なエクステンションを3種類ご紹介いたします。

※以下の内容は、Windows10 環境を前提とし、すべて本稿執筆時点(2019/10/03)のバージョンでのものとなります。

Bracket Pair Colorizer 2

ソースコード上の対となる括弧を色づけして表示してくれるエクステンションです。
1と2があるようですが2のほうがリニューアルされて最適化されている(らしい)です。

Visual Studio Code の Extentions メニューからインストールすれば、とりあえず利用OKですが、設定を変更することで、括弧のスコープを示すラインの表示をオンオフしたり色の指定を変更したりすることができます。

indent-rainbow

こちらは Bracket Pair Colorizer 2 と似たような機能ですが、ソースコード上のインデントの深さに合わせて色を付けてくれるエクステンションです。インデントがずれている行は赤色などで警告してくれます。

設定で色の指定を変更することも可能です。


前述の Bracket Pair Colorizer 2 と indent-rainbow を併用することも可能です。

Salesforce Documenter

JavaDock形式でファイルのヘッダー、メソッドのヘッダーを自動で生成してくれるエクステンションです。

Visual Studio Code の Extentions メニューからインストールします。
設定項目は以下の通りとなってますので、あらかじめ設定しておきましょう。
設定は画面左下の設定アイコンから「設定」を選択し、「拡張機能」メニューの中の「Salesforce Documenter Configuration」の項目で設定します。

設定項目 設定内容
SFDoc.username ファイルとメソッドのヘッダーに表示されるユーザー名
SFDoc.EnableForApex Apexクラスの保存時ファイルヘッダーの自動挿入と更新を有効にする
SFDoc.EnableForVisualforce Visualforceページの保存時ファイルヘッダーの自動挿入と更新を有効にする
SFDoc.EnableForLightningMarkup Lightningマークアップファイルの保存時ファイルヘッダーの自動挿入と更新を有効にする
SFDoc.EnableForLightningJavascript Lightning JavaScriptファイルの保存時ファイルヘッダーの自動挿入と更新を有効にする
SFDoc.IncludParameterTypeInMethodHeader メソッドヘッダーにパラメータタイプと名前を含める
画面上で開いているファイルに対し右クリックメニュー、あるいはコマンドパレットから「Insert file Header」を実行することでヘッダーを挿入してくれます。
あるいは上記設定で自動追加になっていれば、保存時に自動追加されます。

ヘッダーの自動更新を設定しておいた場合、ファイルの保存時に@Last Modified By と @Last Modified On の値が自動更新されます。

@Modification Log は必要な場合に自分の手で追加して行くのがよいでしょう。
またメソッド名を選択した状態で右クリックメニュー、あるいはコマンドパレットから「Generate Apex Method Header」を実行することで引数や戻り値を解析してヘッダーを挿入してくれます。

おわりに

いかがでしたでしょうか。

「Bracket Pair Colorizer 2」と「indent-rainbow」についてはSalesforce開発専用というわけではないので他の言語の開発時でも問題なく使えます。

Visual Studio Codeには今回ご紹介したようなエクステンションが他にも数多く存在します。
自分のスタイルに合ったエクステンションを導入することで、コーディングをより効率よく行うことができます。

次回に続きます。それでは!
24 件
     
  • banner
  • banner

関連する記事