Outils pour utilisateurs

Outils du site


projet_aoc:conventions.de.codage

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Prochaine révision
Révision précédente
projet_aoc:conventions.de.codage [2025/03/02 07:56] – créée - modification externe 127.0.0.1projet_aoc:conventions.de.codage [2025/05/01 08:37] (Version actuelle) – créée - modification externe 127.0.0.1
Ligne 1: Ligne 1:
 +====== Conventions pour la base de données ======
 +je propose de faire comme sur Dolbarr :
 +  * pour chaque table le champ index est nommé **rowid**
 +  * un champ avec une clef étrangère (qui pointe vers l'index d'une autre table) est nommé **fk_nom_de_la_table**
 +
 +====== Conventions pour le code PHP ======
 +
 +Nommage des variables, fonctions ou méthodes
 +
 +  * les noms doivent être explicites
 +  * pour les fonctions ou méthodes c'est bien si ca commence par un verbe à l'infinitif ou mot qui spécifie l'action ou le résultat retourné. Exemples : get, recup, set, add, ajouter, updt, mod, calcul, liste ... en francais si possible
 +  * il y a 2 façons de nommer une variable ou une fonction/methode :
 +      * soit avec des underscores : $nom_de_la_vaiable ou function lister_produits_fournisseurs()
 +      * soit en "camelCase" : $nomDeLaVariable  ou function listerProduitsFournisseur()
 +      
 +===== Convention adoptée =====
 +
 +<note>  * les classes sont en PascalCase (lettre capitale au début)
 +  *     les fonctions sont en camelCase (lettre minuscule au début)
 +  *     les variables sont en camelCase (lettre minuscule au début) de préférence
 +  * 
 +Pour la BD on reste en snake-case ex.  **//table_fournisseurs//**</note>
 +
 +====== Conventions pour les pages HTML ======