Utilisation et gestion des fragments de code

IBM Z® Open Editor est livré avec une bibliothèque d'extraits de code réutilisables pour COBOL, PL/I et JCL afin de vous aider à améliorer votre productivité et à normaliser les modèles de code et les meilleures pratiques. Outre ces snippets prêts à l'emploi, vous pouvez également créer vos propres snippets et importer des snippets provenant de IBM® Developer for z/OS®.

IBM Z Open Editor utilise les fonctions Snippet fournies par VS Code. Pour plus d'informations sur la prise en charge de ce fragment de code, voir les pages d'aide en ligne de VS Code.

Utilisation de fragments de code

Pour explorer et insérer un fragment de code livré avec IBM Z Open Editor, utilisez le sélecteur de fragment de code VS Code Snippet ou la fonction de saisie semi-automatique du code lors de l'édition d'un fichier programme.

Insertion d'un fragment de code à l'aide d'un sélecteur

  1. Placez le curseur sur la colonne 1 dans l'éditeur car les fragments COBOL sont insérés en retrait dans cette colonne.

  2. Ouvrez la palette de commandes VS Code en appuyant sur les touches Ctrl+Maj+P (Windows) ou Cmd+Maj+P (Mac).

  3. Entrez Insert Snippet jusqu'à ce que la commande apparaisse et sélectionnez-la.

  4. En fonction du langage utilisé, une liste déroulante de sélection s'affiche avec les fragments disponibles. Tous les snippets sont organisés en un groupe de snippets apparentés, tels que COBOL Embedded SQL ou COBOL CICS®. De plus, un nom descriptif et un récapitulatif sont attribués à chacun d'eux.

    1. Faites défiler la liste vers le bas ou entrez une sous-chaîne quelconque du fragment recherché.

    2. Sélectionnez le fragment voulu, lequel est ajouté à l'emplacement du curseur.

  5. De nombreux fragments comportent des espaces réservés pour des variables ou des terminaux. Vous pouvez utiliser la touche de tabulation ou Maj-Tab pour passer de l'un à l'autre.

  6. Entrez la nouvelle valeur destinée à remplacer toutes les autres occurrences de l'espace réservé et appuyez sur la touche Entrée pour terminer.

Insertion d'un fragment de code à l'aide de la saisie semi-automatique du code

  1. Lorsque vous éditez un programme, appuyez sur les touches Ctrl+Espace pour commencer la saisie semi-automatique du code.

  2. Dans la liste déroulante, vous verrez d'abord la liste des suggestions de fin de code sensible au contexte fournies par le serveur de langage en supposant que vous travailliez en COBOL ou PL/I. Si vous faites défiler vers le bas, vous voyez la liste des fragments de code ci-dessous.

  3. Vous pouvez à nouveau entrer une sous-chaîne du fragment de code recherché pour vous positionner directement au bon endroit dans la liste déroulante.

  4. Sélectionnez le fragment, lequel est inséré à l'emplacement du curseur.

Création de vos propres fragments de code

Vous pouvez facilement compléter la liste des fragments de code en y insérant le vôtre. Pour cela, procédez comme suit.

  1. Suivez les instructions de VS Code pour créer votre propre collection de fragments.

  2. Dans la liste déroulante des langages, sélectionnez le type cobol, pl1, hlasm ou jcl comme identificateurs de langage pour démarrer une collection de fragments dans ce langage. VS Code ouvre alors une fenêtre d'éditeur contenant les instructions à suivre pour écrire vos propres fragments. Des instructions détaillées sont également fournies dans la page d'aide qui s'affiche au-dessus.

  3. Après avoir ajouté votre premier fragment, sauvegardez-le. Il s'affiche alors dans le sélecteur de fragments décrit précédemment qui est placé avant les fragments IBM.

Importation de fragments de code à partir d'IBM Developer for z/OS

Si vous utilisez IBM Developer for z/OS (IDz) et que vous avez créé des fragments de code personnalisés, vous pouvez exporter ces fragments de code et les importer dans Z Open Editor.

Exportation de fragments de code dans IDz

  1. Pour afficher les fragments disponibles dans IDz, utilisez le menu Window > Show View > Snippets.

  2. Cliquez avec le bouton droit de la souris dans la vue Snippets et sélectionnez Customize....

  3. Dans la boîte de dialogue, recherchez le groupe de fragments que vous souhaitez exporter et cliquez sur le bouton Export.

  4. Indiquez le nom et l'emplacement du fichier d'exportation, qui sera un fichier XML.

Importation de fragments de code IDz dans IBM Z Open Editor

  1. Dans IBM Z Open Editor, ouvrez la palette de commandes de VS Code en appuyant sur les touches Ctrl+Maj+P (Windows) ou Cmd+Maj+P (Mac).

  2. Commencez à saisir IBM Z Open Editor: Import IBM Developer for Z Code Snippets jusqu'à ce que vous voyiez cette commande et sélectionnez-la.

  3. Une fenêtre déroulante de sélection s'affiche pour vous demander le choisir le langage du programme des fragments que vous souhaitez importer. Sélectionnez-en un dans le menu déroulant.

  4. Une boîte de dialogue de fichier apparaît. Accédez au fichier qui a été exporté depuis IDz à l'étape précédente et sélectionnez-le.

  5. Une dernière liste déroulante vous demande de saisir une chaîne de préfixe pour les fragments importés. Ce préfixe est placé devant le nom de chaque fragment à importer, ce qui permet de regrouper les fragments par nom dans le sélecteur de fragments résultant. Vous pouvez laisser cette valeur à blanc et/ou la modifier à nouveau après l'importation.

Si l'importation aboutit, un éditeur de fichier JSON s'ouvre avec les fragments importés au format Microsoft VS Code, comme indiqué dans la page d'aide ci-dessus. Vous pouvez maintenant éditer et modifier les fragments pour les améliorer et y ajouter des espaces réservés.

Si des erreurs se sont produites lors de l'importation, elles s'affichent dans un fichier JSON distinct. Ce dernier s'affiche uniquement s'il y a eu des erreurs.