Convention : Vérifications des noms de variable

Description de l’utilisateur

Le style de codage est un ensemble de règles ou de recommandations à appliquer lors de la rédaction de code source. Le fait de suivre un style de codage spécifié facilite notamment les tâches suivantes :

  • Lecture et compréhension du code source

  • Réduction et détection des problèmes de programmation

  • Maintenance du code source

Sur la base des instructions de programmation (Conventions de dénomination, Préfixes) pour le code source, il existe des requêtes de convention de nom de variable pour vérifier le nom de variable suggéré, par type de données et portée de variable.

Règle de vérification de convention

Pour la vérification de convention, le nom de la variable est combiné avec le type de données associé et le domaine de validité dans lequel la variable est définie.

Portées :

  • Portée de variable locale : Aucun préfixe de portée spécial (VAR ... END_VAR)

  • Portée de variable d'entrée : Préfixe i_ (VAR_INPUT ... END_VAR)

  • Portée de variable de sortie : Préfixe q_ (VAR_OUTPUT ... END_VAR)

  • Portée de variable d'entrée/sortie : Préfixe iq_ (VAR_IN_OUT_ ... END_VAR)

  • Portée de variable globale : Préfixe G_

  • Portée des constantes globales : Préfixe Gc_

  • etc.

Préfixes de nom de variable en fonction du type de données :

  • INT : préfixe i

  • DINT : préfixe di

  • UDINT : préfixe udi

  • REAL : préfixe r

  • LREAL : préfixe lr

  • Bloc fonction : Préfixe fb

  • POINTER TO : préfixe p

  • etc.

Exemple

VAR
    iMyVariable1: INT;
    uiMyVariable1: UINT;
    rMyVariable1: REAL;
    piMyVariable7: POINTER TO INT;
END_VAR
VAR_INPUT
    i_iMyVariable2: INT;
    i_uiMyVariable2: UINT;
    i_rMyVariable2: REAL;
END_VAR
VAR_IN_OUT
    iq_iMyVariable3: INT;
    iq_uiMyVariable3: UINT;
    iq_rMyVariable3: REAL;
END_VAR
VAR_OUTPUT
    iq_iMyVariable2: INT;
    iq_uiMyVariable2: UINT;
    iq_rMyVariable2: REAL;
END_VAR