GB3- Convention de nommage des variables( Temps de lecture estimé à 3 min 51 sec )
Ceci n'est pas vraiment un article mais plutôt une piqûre de rappel d'une évidence que les nouveaux programmeurs ignorent ou dont ils ne tiennent pas compte car inutile pour eux et que certains anciens maltraitent.
Je vous renvoie vers un petit article de Gambix plus que pertinent : Nommage des variables.
Et tant qu'à être dans les rappels : Les variables Globales, Les variables Locales, Conventions de Nommage
Voici un bout de code pour suivre le nommage des variables et leur visibilité dans le code général du programme :
' Gambas class file Inherits TextBox '<--------------------------------------------------------- Tout l'héritage du composant TextBox '<----------------------------------------------------------------------------- (Export) pour créer la class dans l'IDE Export '<------------------------------- remarquez les doubles '' pour faire apparaître les commentaires en explication des objets dans l'IDE Private $value As Float ''Contient la valeur numérique Private $regPat As String ''Pattern des expressions réguliéres Private $format As String ''Contient le formatage de la variable Private $regex As New RegExp ''Contrôle l'entrée, il faut activer gb.pcre Private $bFocus As Boolean ''Boolean du focus Private $listview1 As ListView ''Le listview pour afficher et choisir l'expression régulière Private $TextBox2 As TextBox ''pour afficher les informations sur les expressions régul. Private $lab As Label ''pour afficher le nombre formaté selon l'express. régul. Public Enum sNumVirgule0, sNumVirgule1, sNumVirgule2, sNumVirgule3, sNumVirgule4, sNumVirgule' ne sert qu'à rendre les valeurs plus explicites dans le code ' Static Public ind As Integer Private $ListeC As New String[] '<-------------------------------------------- instanciation de la liste des formats Private $ListeB As New String[] '<-------------------------------------------- instanciation de la liste des explications Private $Liste As New String[] '<--------------------------------------------- instanciation de la liste des expressions régulières Private $obs As Observer '<-------------------------------------------------- les observer peuvent être déclarés en local Private $lvw1Obs As Observer '<---------------------------------------------- ou en global '<------------------- Début propriétés ajoutées à TextBox --------------------- Property Value As Float ''Valeur float de la textbox Property Format As String ''On passe le format que l'on souhaite voir en sortie Property TextReg As Integer ''On passe l'expression régulière Private Sub Value_Write(Value As Float) '<------------------------------------- la propriété Value de notre TextBox $value = Value '<--------------------------------------------------------- récupération de la valeur et transmision à la variable locale End Private Function Value_Read() As Float '<------------------------------------- la propriété Value de notre TextBox Return $value '<---------------------------------------------------------- renvoi de la propriété End Private Sub Format_Write(sFormat As String) '<------------------------------- la propriété Format de notre TextBox $format = sFormat '<------------------------------------------------------ récupération de la valeur et transmision à la variable locale End Private Function Format_Read() As String '<--------------------------------- la propriété Format de notre TextBox Return $format '<--------------------------------------------------------- renvoi de la propriété End Private Function TextReg_Read() As Integer '<--------------------------------- la propriété TextReg de notre TextBox Return $Liste.Find($regPat) '<---------------------------------------------- renvoi de la propriété End Private Sub TextReg_Write(Value As Integer) '<------------------------------- la propriété TextReg de notre TextBox $regPat = $Liste[Value] '<------------------------------------------------ récupération de la valeur et transmision à la variable locale End '<-------------------- Fin propriétés ajoutées à TextBox ---------------------- Public Sub _new() '<--------------------------------------------------------- création et instanciation de tous les objets nécessaires ' Dim $obs As Observer '<--------------------------------------------------- les observer peuvent être déclarés en local ' Dim $lvw1Obs As Observer '<----------------------------------------------- ou en global qui les rend privées Dim sCste As String '<----------------------------------------------------- variables locales pour alimenter le listview Dim i As Integer '<-------------------------------------------------------- variables locales pour alimenter le listview $obs = New Observer(Me) As "obs" '<---------------------------------------- instanciation observer pour récupérer les évènements $listview1 = New ListView(Me.Parent) '<--------------------------------- instanciation listview d'affichage des expressions régulmières $lvw1Obs = New Observer($listview1) As "ListView1" '<---------------------- instanciation observer pour suivre l'évènement _Select $TextBox2 = New TextBox(Me.Parent) '<----------------------------------- instanciation textbox d'affichage d'explications $lab = New Label(Me.Parent) '<--------------------------------------------- instanciation label d'affichage du format
Le préfixe du nom d'une variable est donc une ou plusieurs minuscules suivies d'une majuscule, de mémoire je crois que cela s'appelle la notation Pascal mais bon l'important c'est de rendre la lecture de votre propre code facile à lire et intelligible.
