COURS JavaScript


Accueil | Conventions d'écriture JavaScript

Conventions d'écriture du langage JavaScript

Comme tout langage informatique, JavaScript oblige à respecter (très strictement) plusieurs conventions d'écriture. Faute de quoi, une instruction, une variable, ne serait pas comprise par l'interpréteur.
 


Quel outil utiliser pour écrire du code JavaScript.

Pour ma part, au moins au début, lorsqu'on aborde un langage nouveau, je préconise d'utiliser le traitement de texte le plus simple qui soit sur votre machine. Sous Windows 95/98, le traitement de texte Write.exe (dans le répertoire Windows, tout à la fin) intégré au système d'exploitation me semble le meilleur.
Dans la mesure où le code JavaScript s'intègre à l'intérieur du code HTML, dans la page même, ça me semble la meilleure solution.
Par ailleurs, n'importe quel ordinateur d'aujourd'hui possède au moins un petit traitement de texte simple. Et c'est justement ce qu'il nous faut, puisque le code HTML, comme le code JavaScript doivent être stockés sur le serveur au format texte seul.
Dans le cas où l'on écrit du code JavaScript seul, comme module externe appelé par la page HTML qui en a besoin, le même traitement de texte fera parfaitement l'affaire.
Il existe bien sûr, des dizaines d'éditeurs HTML qui intègrent parfaitement JavaScript. Mais ils ont l'inconvénient de de pas être gratuits, d'une part, et d'autre part, de ne pas forcément être disponible sur la machine sur laquelle on travaille au moment où on a besoin de modifier du code JavaScript dans une page qui se plante dans un site.
Une autre raison me fait préférer et me fait recommander Write.exe (ou tout autre traitement de texte le plus simple possible) : l'apprentissage et l'appropriation du langage et de ses contraintes. On ne connaîtra jamais aussi bien l'écriture d'une instruction ou d'une suite d'instruction que lorsqu'on l'aura écrite et ré écrite des dizaines de fois.
Ceci n'est pas propre à l'apprentissage d'un langage informatique, mais à l'apprentissage tout court. De plus, lorsque l'on "plante" un programme par oubli d'un simple signe indispensable, mais insignifiant, très vite, on n'oublie plus de le mettre.
De plus, et j'en aurai presque fini, malgré toute l'aide (indiscutable) qu'apporte les éditeurs HTML et JavaScript, ceux-ci sont encore loin d'être parfaits. Et seule la connaissance approfondie du langage permet de retoucher le code source pour y ajouter, corriger des fonctions que l'éditeur est encore incapable de générer tout seul.
Pour toutes ces raisons, et bien d'autres, je recommande vivement aux débutants de se prendre par la main, et de n'utiliser qu'un simple petit traitement de texte pour débuter en JavaScript (comme en HTML du reste). Par la suite, dès qu'il est plus aguerri, qu'il maîtrise mieux le langage, alors, il peut utiliser un éditeur qui lui facilitera la vie dans 80% des cas. Mais au moins, il saura résoudre lui même les 20% restant que l'éditeur ne sait pas faire.
 



Majuscules et minuscules

JavaScript sait distinguer les majuscules des minuscules. Tellement bien, que c'est certainement la chose la plus importante à laquelle il faut veiller.

En effet, MaVariable est différent de mavariable et de Mavariable et de maVariable. Pour JavaScript, ce sont quatre variables différentes.
Lorsque l'on décide de nommer une variable ou une fonction d'un certain nom, il faut s'y tenir et ne plus en démordre. Faute de quoi, l'exécution du programme s'en ressentirait gravement. C'est aussi certainement l'erreur de programmation la plus fréquente chez les débutants (chez les confirmés aussi).

Je recommande vivement de se donner des contraintes et des modes de programmation personnels et de d'y tenir.
Par exemple, décider d'écrire tous les noms de variables, fichiers, fonctions (de tout élément imaginé par le programmeur), etc. en minuscules (ou en majuscules) et de ne jamais en démordre. Ainsi, on prend rapidement l'habitude d'un standard que l'on s'est imposé tout seul, et le problème est résolu. Une autre convention est de faire comme dans les pays anglo-saxons, et de décider de mettre une majuscule en début de chaque mot ou partie de mot du nom de la variable. Par exemple MaVariable ou MaFonction, ou MonObjet. C'est une pratique très répandue. Elle a l'inconvénient de ralentir la saisie, et la touche majuscule est tellement près de la touche Ctrl sur les claviers, qu'il y a toujours un risque d'erreur.
Quoi qu'il en soit, fixez vous une convention d'écriture personnelle, et gardez là.



Mots inventés par le programmeur

Dans un programme, il est indispensable de trouver des noms aux variables, aux fonctions et aux objets que nous créons.
Nous avons vu plus haut l'importance de la "casse" dans ces noms. Mais il y a encore plus important. Les noms eux-mêmes.
Bien qu'à ce niveau là, JavaScript laisse toute latitude au programmeur (sauf l'utilisation de caractères spéciaux ou accentués), il est important pour le programmeur de s'y retrouver.
 
 
Donnez toujours des noms représentatifs de l'utilisation que vous allez faire de la variable, de la fonction ou de l'objet créé.

N'étant pas limité dans le nombre de caractères des noms, vous pouvez (et devez) trouver des noms significatifs. Evitez les toto, titi, tata, que l'on rencontre trop souvent dans les programmes. Par exemple :

NumTel pour une variable destinée à recevoir n numéro de téléphone
NbChamps pour une variable représentant le nombre de champs d'un formulaire.
function CalculRes() pour une fonction calculant un résultat.

etc.



Mots réservés JavaScript

Comme tout langage informatique, JavaScript possède ses mots réservés. Ce sont ceux que l'interpréteur sait reconnaître, et grâce auxquels il fait ce qu'on lui dit de faire.
Il n'est pas question ici de dresser la liste de ces mots réservés, nous les apprendrons au fur et à mesure par la pratique. Ce qu'il faut en revanche savoir, est comment ils s'orthographient, majuscules et minuscules incluses.
Comme pour les mots inventés par le programmeur, JavaScript sait reconnaître les majuscules et les minuscules dans ses mots réservés. Contrairement à HTML qui ignore complètement la "casse" (majuscules ou minuscule).
Alors prudence et attention soutenue. onLoad est différent de OnLoad. (c'est onLoad qui est le bon !)
 



Commentaires dans le code source

En JavaScript, un commentaire peut s'écrire de deux manières différentes suivant qu'il tient sur une seule ligne ou qu'il s'étend sur plusieurs lignes.

1 ) - Un commentaire tenant sur une seule ligne s'écrit comme suit :

// Commentaire du programmeur

La fin du commentaire est repérée par le retour chariot (appui sur la touche "Entrée"). Un commentaire peut se mettre aussi bien en début de ligne comme par exemple :

// Début du traitement des champs

ou bien à la fin d'une instruction :

function MaFonction() {       // début de la fonction de traitement des champs du formulaire.

2) - Un commentaire tenant sur plusieurs lignes s'écrira comme suit :

/* ce commentaire s'écrit
sur deux ou plusieurs lignes */

les signes */ indiquent à l'interpréteur que tout ce qui suit /* sera considéré comme un commentaire jusqu'à ce qu'il rencontre les signes */ qui indiquent la fin du commentaire.
 
 
Je n'insisterais jamais trop sur l'importance des commentaires dans un programme.
C'est ABSOLUMENT INDISPENSABLE et A TOUS LES NIVEAUX.

Chacun sait et a conscience de l'impossibilité matérielle et psychologique que le programmeur rencontre lorsqu'on lui parle de documentation de programme. Pas le temps, ça sert à rien, du temps de perdu, etc. sont les remarques les plus fréquemment entendues.
Cependant, les programmeurs expérimentés, ont tous fait l'apprentissage de la maintenance de programmes. Et chacun sait combien il est difficile de "rentrer" dans le code écrit par un autre si on ne possède aucune documentation et s'il n'y a aucun commentaire dans le source.
Il en va de même lorsqu'on a écrit soi même le programme, mais qu'on doit le retoucher plusieurs années on même quelques mois plus tard, alors que l'on a écrit bien d'autres programmes entre temps. On ne se souvient plus a quoi sert telle ou telle variable etc. Surtout avec un langage pseudo objet comme JavaScript. Si l'on a pas pris soin de donner des noms significatifs de leur rôle aux variables et aux fonctions crées, on est complètement perdu. A tel point qu'il est souvent plus facile et plus rapide de ré-écrire tout le programme que de rentrer dedans pour le modifier.

Alors, si l'on n'a pas le temps (ou le courage) de documenter ses œuvres, au moins, mettez des commentaires dans le code source. Vous ne serez jamais déçus de cette "perte de temps".
 
 




Ce cours est enseigné par Philippe Médan 
dans le cadre de la formation des professionnels de l'INTERNET.
au CREFAC , 14 rue Scandicci, 93000 Pantin. Tél. : 01 48 46 51 99
au GITA-GRETA , Lycée Technologique Diderot 61, rue David D'Angers 75019 Paris Tél. : 01 40 40 36 27
au CESI à l'Ecole des ingénieurs, 116 Av Aristide Briand, BP 57, 92224 Bagneux CEDEX Tél. : 01 45 36 70 00
au CFA-AFIA Centre de Formation par l'Apprentissage spécialisé en Informatique DUT Licence MIAGE,
PUIO - Bâtiment 640 - Plateau du Moulon - 91405 Orsay Tél. : 01 69 15 35 19.

© Philippe Médan 1999-2007. Tous droits de reproduction réservés pour tous pays.