Formation développement Web PHP gestion des fichiers, tutoriel & guide de travaux pratiques en pdf.

Conventions de codage

Definition (Conventions de codage)
Elles servent a` mettre en place des normes de maniere` a` ce qu’un programmeur puisse relire et comprendre facilement le code produit par d’autres programmeurs.
certaines conventions sont dictees´ par le langage d’autres sont etablies´ par les programmeurs et concernent :
le nommage des variables et fonctions
la dispositions des blocs (if-then-else, while, …)
le nommage des parametres,` …
nommage des variables et fonctions
Conventions a` appliquer
les noms doivent etreˆ courts et explicites
les noms de variables et fonctions ne contiennent que des lettres minuscules et le symbole souligne´ ‘ ‘
un nom de variable est mis au pluriel s’il contient plusieurs el´ements´
une methode´ qui retourne un attribut d’une classe doit commencer par get
une methode´ qui fixe un attribut d’une classe doit commencer par set
Disposition des blocs
On utilisera pref´erentiellement´ la syntaxe :
Disposition des blocs
1 function divise($a, $b) {
2 if ($b==0) {
3 throw new exception(« zero ») ;
4 } else {
5 return $a/$b ;
6 }
7 }
Autres conventions
on supprime le plus possible les espaces inutiles on declare´ les variables au moment ou` on les utilise on sort des boucles les calculs inutiles ou redondants (refactoring) on documente les fonctions, methodes´ et variables / attributs
Exemple
Convention en application
1 function moyenne($arr notes) {
2 $nbr=count($arr notes) ;
3 $somme=0 ;
4 for ($i=0 ;$i<$nbr ;++$i) {
5 $somme+=$arr notes[$i] ;
6 }
7 return $somme/$nbr ;
8 }
Documentation
A quoi sert la documentation du code ?
Elle a pour but d’expliquer au programmeur qui ne connait pas le code :
ce que contiennent les variables
ce que font les fonctions (role,ˆ comportement, parametres` en entree´ / sortie, valeur de retour)
A quoi sert la documentation du code ?
Elle a pour but d’expliquer au programmeur qui ne connait pas le code :
ce que contiennent les variables
ce que font les fonctions (role,ˆ comportement, parametres` en entree´ / sortie, valeur de retour)
PHP + Doc
C’est d’autant plus important en PHP etant´ donne´ l’absence de typage et la non distinction entre procedure´ et fonction.
Commentaires
Il existe trois types de commentaires
// commentaire sur une ligne
/* commentaire
sur plusieurs lignes */
/** commentaire
pour documentation */
Il existe trois types de commentaires
// commentaire sur une ligne
/* commentaire
sur plusieurs lignes */
/** commentaire
pour documentation */
A noter
il ne faut pas mettre de ligne blanche entre le commentaire de documentation et la variable ou la fonction a` laquelle il se rapporte.

PLAN
1 Frameworks
2 Conventions de codage
3 SPL
4 Gestion des fichiers