Le Blog de DSR57 - Programmation WinDev

Introduction

Dans une suite de billets j'avais présenté une norme de nommage des différents éléments WinDev que je préconise et met en place lors de mes différentes programmations. Avec ce billet, je propose une amélioration sur le nom des procédures visant à améliorer la compréhension des traitements effectués par la celles-ci en lisant leur nom, pour cela j'ai mis en place un nouvelle partie dans le nom visant à isoler l'action de la procédure.Dans un premier temps nous allons voir la mise en place de cette amélioration pour les procédures globales, ensuite les procédures locales et pour terminer les procédures (généralement appelées méthodes) de classe.

Liste des billets sur les normes de programmation en WinDev :

• WinDev : normes de programmation pour les variables de type simple
• Windev : normes de programmation pour les procédures et les champs graphiques
  WinDev : normes de programmation pour la POO

Global au projet (Collections de procédures)


Les procédures déclarées dans une collection de procédures ont une portée globale au projet. Le nom sera composé de 3 parties :

• préfixe : obligatoire et fixe «GProc». «G» pour globale au projet, «Proc» pour procédure;
• action : obligatoire, cette partie permet en un mot de définir le type d’action de la procédure. Cf. liste des actions ci-dessous.
• nom : obligatoire, il doit être explicite pour permettre à la lecture de comprendre le traitement de la procédure. Par convention le nom est écrit en minuscule, sans accent, sans caractère spéciaux (€,$,%, …), et commence par une minuscule. Si le nom de l’élément est composé de plusieurs mots, la première lettre du mot est en majuscule.

Les trois parties seront séparées par le caractère «_».

Exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

GProc_Ini_VarGbl : Procédure qui initialise les variables globales au projet.

Liste des actions:

• Afc : Affichage;
• Ajt : Ajout;
• Clc: Clic sur un bouton;
• Ent: Entrée dans un champ;
• Ini: Initialisation;
• Lst: Récupération d’une liste de valeur ou une liste d’objet;
• Raz: remise à zéro;
• Rch: Recherche;
• Rcp: Récupération d’une valeur ou d’un objet;
• Sel: Sélection (ligne de table, combo);
• Sor: Sortie d’un champ;
• Spr: Supprime/suppression;
• Vrf: Vérification.

Cette liste est non exhaustive, elle doit être complétée/améliorée/modifiée selon les besoins de chacun. J'ai volontairement oublié l'action EXE, pour éviter une utilisation massive et/ou abusive, l'utilisation de cette action est réservée pour l'exécution requêtes SQL, Script, ...

Local à un élément du projet


Les procédures déclarées dans un élément local du projet ont un portée local, elles ne sont pas accessibles depuis un élément extérieur. Le nom sera composé en 3 parties :

• Préfixe: Obligatoire et fixe «lProc».
• Action: Obligatoire, cette partie permet en un mot de définir le type d’action de la procédure. Cf. liste des actions dans le paragraphe «Global au projet (Collections de procédures)».
  
• Nom: Obligatoire, il doit être explicite pour permettre à la lecture de comprendre le traitement de la procédure. Par convention le nom est écrit en minuscule, sans accent, sans caractère spéciaux (€,$,%, …), et commence par une minuscule. Si le nom de l’élément est composé de plusieurs mots, la première lettre du mot est en majuscule.

Les trois parties seront séparées par le caractère «_».

Exemple:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
lProc_Sel_typeMediaCbx : Procédure qui gère la sélection d’une ligne dans la liste Type de média. 
LProc_Ini_typeMediaCbx : Procédure qui gère l’initialisation de la combo type de média.

Classes

Les procédures de classes sont soit public, protégée, ou privée, dans la convention de nommage, cette notion n’est pas prise en compte, car lors de la programmation en objet, WinDev fait la complétion automatique en proposant uniquement les procédures avec une portée accessible. Le nom est composé de deux parties :

• Action: Obligatoire, cette partie permet en un mot de définir le type d’action de la procédure. Cf. liste des actions dans le paragraphe «*Global au projet (Collections de procédures)*». Une exception est appliquée pour les procédures des gestions des requêtes, la partie action commence par «*Exe*»
  
• Nom: Obligatoire, il doit être explicite pour permettre à la lecture de comprendre le traitement de la procédure. Par convention le nom est écrit en minuscule, sans accent, sans caractère spéciaux (€,$,%, …), et commence par une minuscule. Si le nom de l’élément est composé de plusieurs mots, la première lettre du mot est en minuscule.

Exemple :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
lst_societe: récupère la liste des sociétés
lst_clientDebiteur : récupère la liste des clients qui ont un compte débiteur