Commentaires dans l’Éditeur ST

Introduction

Vous pouvez utiliser des commentaires dans votre code pour permettre aux autres de comprendre l’intention d’un programme ou d’une fonction. Des commentaires peuvent être placés à n’importe quel endroit, là où un caractère d’espacement est autorisé, sauf dans des littéraux chaînes de caractères. Les commentaires n’ont pas d’impact sur l’exécution d’un programme.

Commentaires sur une ligne

Les commentaires sur une ligne commencent par une double barre oblique // et finissent à la fin de la ligne. Dans des commentaires sur une ligne, les combinaisons de caractères spéciaux (* et *) ou /* et */ n’ont pas de sens particuliers comme dans des commentaires multilignes.

Les commentaires sur une ligne sont pris en charge par Control FPWIN Pro7 à partir de la version 7.6.0.0. Elles provoquent une erreur de compilation dans les versions précédentes de Control FPWIN Pro7.

Commentaires multilignes

Les commentaires multilignes commencent par (* et se terminent par *) ou ils commencent par /* et se terminent par */. Ce type de commentaire peut s’étendre sur plusieurs lignes. Dans les commentaires multilignes, la combinaison de caractères spéciaux // n’a pas de sens particuliers comme dans les commentaires sur une ligne.

(*-------------------
* Calculate
fan speed *)

/*-------------------
* Calculate fan speed
*/

Imbriquer des commentaires multilignes

Un commentaire imbriqué est un commentaire à l’intérieur d’un autre commentaire. Les commentaires peuvent être imbriqués si l’option suivante est activée : Extras > Options > Options de compilation > Erreurs additionnelles > Commentaires multilignes imbriqués.

Avec des commentaires imbriqués, vous pouvez rapidement et facilement commenter de larges blocs de codes même si le code contient déjà des commentaires multilignes.

/* This is a multi-line comment
(* this is also a multi-line comment*) /*another multi-line comment*/
This is still part of the multi-line comment */

(* Commented out code
/* Calculate fan speed */
bFan := TRUE; // Turn on the fan
*)

Commentaires incorrects

(* wrong comment end characters */
/* wrong comment end characters *)

/* Incorrect comment
/* /* This should be incorrect.
*/

URL (Uniform Resource Locator) dans des commentaires

Des URL peuvent être utilisés dans des commentaires. Appuyez sur <Ctrl> et cliquez sur le texte de l’URL pour ouvrir l’URL dans votre navigateur par défaut ou une application de messagerie.

// sample comment https://www.google.com

// sample comment https://www.google.com/search?q=panasonic

// sample comment mailto:email@example.com

// sample comment mailto:email@example.com?cc=secondemail@example.com,anotheremail@example.com,
&bcc=lastemail@example.com&subject=Mail%20from%20our%20Website

// sample comment file://C:\filename.txt

// sample comment file://C:\foldername

// sample comment ftp://username@192.168.178.55:8000

Afficher la liste de saisie automatique dans les commentaires

Si vous voulez insérer un nom de variable ou d’instruction dans un commentaire, vous pouvez afficher la liste de saisie automatique avec le raccourci clavier <Ctrl>+<Espace>.