ColdFusion コードの操作

Visual Studio Code 用 Adobe ColdFusion Builder 拡張機能には、CFM ファイル、CFC ファイル、HTML ファイル、JavaScript ファイルおよび CSS ファイルに対応する多彩なコード編集機能を備えた CFML エディターが組み込まれています。CFML エディターは、コード補完や効率的なコードナビゲーションなどの機能を提供することで、コードの記述を支援します。CFML エディターでは、様々な色やフォントを使用してワークスペース内のコードを表示できます。

この拡張機能で使用できる機能には、その他に次のものがあります。

• コードアシスト
  
• 辞書サポート
  
• コードのリファクタリングと整形
  
• コードナビゲーションとアウトライン
  
• コードの折りたたみと展開
  
• コードの色付け
  
• 状況依存型ヘルプ
  

コードアシスト

コードアシストは、コードの完成を支援する機能です。入力するコードに応じて、コードの完成を支援するヒントが表示されます。CFML エディターでコードを入力する際には、コードアシストにより、有効な CFML タグ、パラメーター、属性のリストが表示されます。これらの項目は、ポップアップメニューに表示されます。CFML コード内に HTML、JavaScript、または CSS コンテンツを記述する場合は、コードアシストにより、それらのコードを完成させるためのヒントも表示されます。コード完成ヒントを CFML エディターに挿入するには、ダブルクリックするか Enter キーを押します。

コードアシストの使用

コードアシストは、コードの完成を支援する機能です。入力するコードに応じて、コードの完成を支援するヒントが表示されます。CFML エディターでコードを入力する際には、コードアシストにより、有効な CFML タグ、パラメーター、属性のリストが表示されます。これらの項目は、ポップアップメニューに表示されます。CFML コード内に HTML、JavaScript、または CSS コンテンツを記述する場合は、コードアシストにより、それらのコードを完成させるためのヒントも表示されます。コード完成ヒントを CFML エディターに挿入するには、ダブルクリックするか Enter キーを押します。

コードアシストの使用

コードヒントは、フレームワークまたは言語（CFML、HTML、JavaScript、および CSS）によって現在のコード式を完成させるためのオプションが提示されるときに毎回表示されます。 

例えば、CFML タグの内容を入力する場合は、そのタグで指定できるすべての属性のリストが表示されます。

CFM ページに関するコードアシスト

• 「<cf」と入力して Ctrl + スペースバーを押すと、事前定義された属性と値のドロップダウンリストが表示されます。

• createobject() または <cfobject> タグを使用してロードできるコンポーネント（CFC）のリストが表示されます。

• CFC 内で作成されたメソッドが表示されます。これは CFM 内で作成されたコンポーネントオブジェクトを使用して呼び出すことができます。すべての拡張済み CFC ファイルのメソッドのリストも表示されます。 

• すべてのビルトイン関数とユーザー定義関数のドロップダウンリストが表示されます。

• 構造体、配列、クエリなどの変数のリストが表示されます。これらの変数は、ページ内で宣言されています。これらの変数は、属性値のコードアシストとしても表示されます。

• <cfquery> や queryNew() を使用して作成されたすべてのクエリが表示されます。レコードセットを表示するには、「<cfoutput query="">」と入力して Enter キーを押します。または、queryname. を使用します（つまり、最後にドットがついたクエリ名を使用します）。

• {{<cfinclude>}} タグを使用して現在の CFM ページに取り込まれた、別の CFM ページの関数、変数、タグ、クエリも表示されます。 

クイックフィックス

クイックフィックスとは、コードの誤りにフラグを立て、修正案を提供することです。例えば、CFC を作成する際に、その CFC がまだ存在しない場合や、間違った CFC を指定した場合は、拡張機能にエラーが表示されます。

コードの下の「問題」タブにエラーメッセージが表示されます。 

問題のある行の近くに、修正案と共に黄色い電球が表示されます。 

修正案をクリックすると、この場合は、CFM と同じフォルダーに CFC mycfc1 が作成されます。コードにも新しい CFC の名前が反映されます。

同様に、ローカルまたは外部 CFC のあらゆる UDF のエラーを修正できます。 

いずれの場合も、この拡張機能により、スケルトンコードがあらかじめ入力された CFC が作成されます。

次のような状況でも、クイックフィックスは役に立ちます。

• ローカル UDF の呼び出し：例えば、cfset や cfscript の代入、関数の引数、その他の式など。UDF 内で引数を指定すると、クイックフィックスがその引数も作成します。
• CFC のメソッド呼び出し：例えば、function1 が cfc1 で定義されていない場合、クイックフィックスによって作成されます。
• createObject、new、cfobject および cfinvoke からの CFC の作成。
• cfinclude および cfmodule からの CFM ページの作成。
• extends および implement 属性からの CFC および CFM の作成

定義へ移動

Command キー（macOS）または Ctrl キー（Windows）を押しながらクリックすると、関数または CFC に直接移動できます。 

関数呼び出しや CFC 呼び出しでは、Ctril キーを押しながらクリックすると、定義に直接移動します。 

ローカル UDF でも外部 CFC でも、Ctrl／Command キーを押しながらクリックすると、関数の定義が表示されます。 

シンタックスチェック

CFM ファイル内のタグまたはコードブラケットを選択すると、そのタグまたはブラケットに対応するペアが自動的に強調表示されます。 

入力したコードが有効な CFML コードとして認識されない場合は、状況に応じて適切に通知されます。

「問題を表示」をクリックすると、コードのエラーが表示されます。

その他のシンタックスエラーを表示するには、「前へ」／「次へ」の矢印を使用します。 

コードリファクタリング

コードリファクタリングとは、全体的な結果を変更せずにプログラムのソースコードを改善するプロセスです。一般に、コードリファクタリングを行うと、コードの可読性と保守性が向上します。 

VS Code 拡張機能では、CFC、CFM および UDF の名前変更、検索、プレビューなど、様々なリファクタリング手法がプロジェクトレベルおよびワークスペースレベルでサポートされています。

CFC ファイル名または CFM ファイル名のリファクタリング

CFC または CFM の名前を変更する場合は、その CFM または CFC へのすべての参照を含め、CFM または CFC の有効なインスタンスをすべてリファクタリングできます。

参照検索

リファクタリングした UDF、CFC または CFM がプロジェクトのどこで使用されているかを確認できます。 

ファイルを右クリックし、「ファイル参照を検索」を選択します。