Introduction

Voici la page regroupent la nomenclature mis en place pour ce site.

Fichiers

Pour tous les fichiers une nomenclature en CamelCase doit être mise en place.

Ex. homePage.php

Fonction et variables

Toutes fonction et variable doivent utiliser une nomenclature en CamelCase.

Ex. function addUser()

Ex. $userEmail

Commentaires

Les commentaires de fonction se trouvent au dessus de la fonction, elle doit être définie au minimum par :

• @brief -> il résume la fonction

les commentaires d'une partie de code se trouvent au dessus de la partie de code à commenter.

En-tête

Chaque fichiers aura une entête spécifique :

Project : ProgWEB - Images upload site

 @file      NOM_DU_FICHIER

 @brief     RESUME_DE_LA_FONCTION_DU_FICHIER

 @author    Created by NOM_DE_L'AUTEUR

 @version   VERSION (DATE)

PHP STORM - Automatisation

Sous 'Settings/Editor/File and Code Template/PHP File' Ajoutez

/**
 * Project : ProgWEB - Images upload site
 * @file      ${FILE_NAME}
 * @brief     This --- is used to ---
 * @author    Created by ${USER}
 * @version   1.0 (${DATE})
*/

Spécificité

Les nom de fichier, fonction ou variable comportant le mot "ID" doit s'écrire entièrement en majuscule.