コード・スニペットの使用と管理

IBM Z® Open Editor には、生産性の向上や、コード・パターンとベスト・プラクティスの標準化に役立つように、COBOL、PL/I、および JCL の再利用可能なコード・スニペットが入ったライブラリーが付属しています。 すぐに使用できるこれらのスニペットに加えて、独自のスニペットを作成することも、IBM® Developer for z/OS® からスニペットをインポートすることもできます。

IBM Z Open Editor は、VS Code に装備されているスニペット機能を利用します。 このコード・スニペットのサポートについて詳しくは、VS Code のオンライン・ヘルプのページを参照してください。

コード・スニペットの使用

IBM Z Open Editor に付属しているコード・スニペットを探索して挿入するには、プログラム・ファイルを編集しながら VS Code のスニペット・ピッカーとコード補完機能のどちらかを使用します。

ピッカーを使用したコード・スニペットの挿入

  1. COBOL のスニペットはエディターの 1 桁目を基準にしてインデントされるので、1 桁目にカーソルを置きます。

  2. Ctrl + Shift + P (Windows の場合) または Cmd + Shift + P (Mac の場合) を押して VS Code のコマンド・パレットを開きます。

  3. 「Insert Snippet」と入力していき、「スニペットの挿入」コマンドが表示されたら選択します。

  4. 使用している言語に基づいて、使用可能なスニペットをリストしたピッカーのドロップダウンが表示されます。 すべてのスニペットが、「COBOL 組み込み SQL (COBOL Embedded SQL)」や「COBOL CICS®」など、関連するスニペットのグループに編成されています。 各スニペットの記述名と要約も表示されます。

    1. リストをスクロールダウンするか、探しているスニペットの文字列の一部を単に入力します。

    2. 挿入するスニペットを選択すると、そのスニペットが現在のカーソル位置に挿入されます。

  5. 多くのスニペットには、変数またはターミナルのプレースホルダーがあります。 Tab キーまたは Shift と Tab キーを使用して、プレースホルダー間を移動できます。

  6. 新しい値を入力してプレースホルダーの現在の出現個所と他のすべての出現個所を置換し、Enter キーを押して終了します。

コード補完を使用したコード・スニペットの挿入

  1. プログラムを編集しながら Ctrl + Space を押すと、コード補完が開始されます。

  2. ドロップダウン・リストに、まず、コンテキスト依存のコード補完候補が表示されます。これらの候補は、COBOL または PL/I のどちらかが使用されていると想定した上で言語サーバーから提供されます。リストをスクロールダウンすると、下にあるコード・スニペットを表示できます。

  3. さらに、コード・スニペットの文字列の一部を入力すると、探しているスニペットが検索され、ドロップダウン内のそのスニペットにジャンプできます。

  4. スニペットを選択すると、そのスニペットが現在のカーソル位置に挿入されます。

独自のコード・スニペットの作成

以下の手順に従って、コード・スニペットのリストに独自のスニペットを簡単に追加できます。

  1. VS Code の説明に従って、独自のスニペットのコレクションを作成します。

  2. 言語ドロップダウンから、言語識別子のタイプとして cobol、pl1、hlasm、または jcl を選択し、その言語のスニペット・コレクションの作成を開始します。 VS Code のエディター・ウィンドウが開き、独自のスニペットを作成する方法が表示されます。 上記のヘルプ・ページにも、詳しいガイダンスが記載されています。

  3. 最初のスニペットを追加したら、それを保存します。 保存したスニペットは、前述のスニペット・ピッカーに IBM スニペットより前に表示されます。

IBM Developer for z/OS からのコード・スニペットのインポート

IBM Developer for z/OS (IDz) を使用していて、そこで既にカスタム・コード・スニペットを作成した場合は、そのコード・スニペットをエクスポートして、Z Open Editor にインポートすることができます。

IDz でのコード・スニペットのエクスポート

  1. IDz で使用可能なスニペットを表示するには、**「ウィンドウ」>「ビューの表示」>「スニペット」**メニューを使用します。

  2. 「スニペット」ビューの任意の場所を右クリックし、**「カスタマイズ.. 」**を選択します。

  3. ダイアログで、エクスポートするスニペット・グループを見つけて、**「エクスポート」**ボタンをクリックします。

  4. エクスポート・ファイルの名前と場所を指定します。エクスポート・ファイルは XML 形式になります。

IBM Z Open Editor への IDz コード・スニペットのインポート

  1. IBM Z Open Editor で、Ctrl + Shift + P (Windows の場合) または Cmd + Shift + P (Mac の場合) を押して VS Code のコマンド・パレットを開きます。

  2. 「IBM Z Open Editor: Import IBM Developer for Z Code Snippets」と入力していき、このコマンドが表示されたら選択します。

  3. ドロップダウン・ピッカーが表示され、インポートするスニペットのプログラミング言語の選択を求められます。 ドロップダウン・メニューから、いずれかの言語を選択します。

  4. ファイルのダイアログが表示されます。 前の手順で IDz からエクスポートしたファイルに移動して選択します。

  5. 次に、最後のテキストのドロップダウンが表示され、インポートするスニペットの接頭部の文字列を指定するように求められます。 この接頭部が、インポートするすべてのスニペットの名前の先頭に追加されるので、インポート後のスニペット・ピッカーで名前を使用してスニペットをグループ化できるようになります。 この値を空にすることも、インポート後に再び編集することもできます。

インポートが成功すると、上記のヘルプ・ページで説明されているように、JSON ファイル・エディターが開き、インポートされたスニペットが Microsoft VS Code 形式で表示されます。 そこで、スニペットを編集および変更してスニペットを改良したりプレースホルダーを追加したりできます。

インポート中にエラーが発生した場合は、別の JSON ファイルにそれらのエラーが表示されます。 このファイルが表示されるのは、エラーが発生した場合のみです。