Skip to main content

Commentaires ST

Commenter

La description

Exemple

Une seule ligne

Il existe deux manières de marquer :

  • Commence avec // et se termine à la fin de la ligne

  • Commence avec /// et se termine à la fin de la ligne

Dans CODESYS, ces commentaires sont traités de la même manière.

Cependant, si la documentation de la bibliothèque est créée à l'aide de la collection de scripts LibDoc, ce qui suit s'applique :

  • Lorsque la propriété LibDocContent = DocsOnly est saisi dans les informations du projet, seuls les commentaires marqués d'un /// sont transformés en documentation de bibliothèque. Voir l'exemple ci-dessous le tableau.

  • Lorsque LibDocContent = CommentsAndDocs (paramètre par défaut) est défini, tous les commentaires sont traités dans la documentation de la bibliothèque.

/// This is a comment

/// This is a comment

Multiligne

Commence avec (* et se termine par *).

(* This is a multiline comment *)

Imbriqué

Commence par (* et se termine par *). Commentaires supplémentaires (*....*) peut être contenu dans ce commentaire.

( * a:=inst.out; (* comment 1 *) b:=b+1; (* comment 2 *) *)

Les commentaires sont affichés sous forme d'informations sur une variable dans la colonne de commentaires de la déclaration de variable en mode en ligne, ainsi que dans l'info-bulle lorsque le pointeur de la souris est positionné sur une variable. La logique et la hiérarchisation suivantes s'appliquent

  1. Quand un commentaire commençant par /// se trouve avant la variable, ce commentaire est affiché.

  2. Quand un commentaire commençant par // ou dans (**) se trouve après la déclaration de variable sur la même ligne, ce commentaire est affiché

  3. Quand un commentaire commençant par // ou dans (**) se trouve avant la déclaration de variable sur la même ligne, ce commentaire est affiché

Si un commentaire ne peut pas être affiché dans son intégralité en mode en ligne en raison de sa longueur, _cds_icon_comment_more_lines.png le symbole est affiché dans ce champ de commentaire. Lorsque le curseur est ensuite placé sur ce symbole, le commentaire complet s'affiche dans l'info-bulle

Exemple 79. Commentaires pour les info-bulles et la documentation des POU
A tooltip in the header of a POU is defined by the following comment:
    // tooltip text – line 1
    // tooltip text – line 2
    // tooltip text – line 3

    Afterwards the documentation is defined as follows:
    /// reStructuredText


Remarque : Les différents types de commentaires peuvent être utilisés pour contrôler quels commentaires doivent être affichés dans la documentation d'une bibliothèque et quels commentaires sont destinés uniquement aux développeurs de bibliothèques.

Dans cette section​: