Skip to main content

ST Commenti

Commento

Descrizione

Esempio

Linea singola

Ci sono due modi per marcare:

  • Inizia con // e finisce alla fine della riga

  • Inizia con /// e finisce alla fine della riga

In CODESYS, questi commenti vengono gestiti allo stesso modo.

Tuttavia, se la documentazione della libreria viene creata utilizzando LibDoc Scripting Collection, si applica quanto segue:

  • Quando la proprietà LibDocContent = DocsOnly è inserito nelle informazioni sul progetto, solo i commenti contrassegnati con /// vengono elaborati nella documentazione della biblioteca. Vedi l'esempio per questo sotto la tabella.

  • quando LibDocContent = CommentsAndDocs (impostazione predefinita), tutti i commenti vengono elaborati nella documentazione della libreria.

/// This is a comment

/// This is a comment

Multilinea

Inizia con (* e finisce con *).

(* This is a multiline comment *)

Nidificato

Inizia con (* e termina con *). Commenti aggiuntivi (*....*) può essere contenuto in questo commento.

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

I commenti vengono visualizzati come informazioni su una variabile nella colonna dei commenti della dichiarazione della variabile in modalità online, nonché nel tooltip quando il puntatore del mouse è posizionato su una variabile. Si applicano la logica e la definizione delle priorità seguenti

  1. Quando un commento inizia con /// è prima della variabile, viene visualizzato questo commento.

  2. Quando un commento inizia con // o entro (**) dopo la dichiarazione della variabile nella stessa riga, viene visualizzato questo commento

  3. Quando un commento inizia con // o entro (**) è prima della dichiarazione della variabile nella stessa riga, viene visualizzato questo commento

Se un commento non può essere visualizzato per intero in modalità online a causa della sua lunghezza, allora _cds_icon_comment_more_lines.png il simbolo viene visualizzato in questo campo di commento. Quando il cursore viene quindi posizionato su questo simbolo, il commento completo viene visualizzato nella descrizione comando

Esempio 79. Commenti per descrizioni comandi e documentazione 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


Nota: i diversi tipi di commenti possono essere utilizzati per controllare quali commenti devono essere visualizzati nella documentazione di una libreria e quali sono destinati solo agli sviluppatori di librerie.

In questa sezione: