Conventions d'ecriture pour le langage JavaScript

fichiers JavaScript

Le programmes JavaScript doivent être stockés et livrés en fichiers.js . le code JavaScript ne devrait pas être intégré dans les fichiers HTML, sauf si le code est spécifique à une seule session.Car dans le fichier HTML il s'ajoute de manière significative sans possibilité de d'atténuation la mise en cache de compression.

Les espaces

Lorsque cela est possible, ces règles sont compatibles apres des siècles de bonnes pratiques avec un style littéraire. Les écarts par rapport au style littéraire ne devraient être tolérés que s'il y a des preuves solides d'un avantage important. Les lignes vides améliorer la lisibilité en créant des sections de code qui sont logiquement liées. Les espaces vides doivent toujours être utilisés dans les cas suivants:

Un mot-clé suivi par une parenthèse gauche --( -- doit être séparé par un espace. Les espaces sont utilisés pour que les choses qui ne sont pas des invocations ressemblent moins à des invocations, ainsi par exemple, il devrait y avoir d'espace après if ou while

while "espace" (true) {

Le mot fonction est toujours suivi par un espace.

Aucun espace ne doit séparer un opérateur unaire et son opérande sauf lorsque l'exploitant est un mot tel que typeof.

Tous les opérateurs binaires devraient être séparés de leurs opérandes par un espace de chaque côté.

Sauf exception pour : --(-- parenthèse gauche et --[-- crochet gauche.

Chaque --- , ---virgule devrait être suivi par un espace ou un saut de ligne.

Chaque--- ; ---Point virgule à la fin d'une instruction doit être suivie d'un saut de ligne.

Chaque--- ; ---Point virgule dans la partie de commande d'un de déclaration devrait être suivie par un espace.

Si vous voulez pas voir Theo comme sa










Ou Guillaume comme sa










Surtout ne faite pas sa !!!


					function Alert(sA)
					{
				if(!document.getElementsByTagName) return;
				varoA= document.getElementsByTagName(sA);
				if  (!oA) return;
				variI = oA.length - 1;
				for(iI;iI >= 0; iI--) {
				if(oA[iI].className == 'alert')  {
				oA[iI].onclick = function()   {
				window.alert('coucou');
				return false;
					  };
					  }
					}
					}

					window.onload = function()
					{
					   Alert('a');
					};
Car ceci est incomprehensible !
Mais ça

			// Avec quelque commentaire sympa

function Alert(sA)
{
if(!document.getElementsByTagName) return;//si vous voulez


var oA = document.getElementsByTagName(sA);
if(!oA) return;//Sa mange pas de pain


var iI = oA.length - 1;

for(iI; iI >= 0; iI--)
{
	if(oA[iI].className == 'alert')
	{
			oA[iI].onclick = function()
			{
			window.alert('coucou');
			 return false;
	 };
	}
 }
}
//et la quennelle passe mieux
window.onload = function()
{
Alert('a');
};
							              
La c'est beaucoup mieux!!

Les commentaires

Soyez généreux avec les commentaires. Il est utile de laisser une information car elle sera lu à une date ultérieure par des personnes qui auront besoin de comprendre ce que vous avez fait et pourquoi. Les commentaires doivent être bien écrit et clair. Une petite touche d'humour occasionnelle peut être appréciée.

Attention

des commentaires erronés peuvent rendre les programmes encore plus difficile à lire et à comprendre

Faite des observations pertinentes. Concentrez-vous sur ce qui est pas immédiatement visible. Ne perdrer pas votre temps pour ecrire :

						i = 0; // Définir i à zéro.
					
Ne soyet pas sôt!!!

Pourquoi ???

Si les commentaires sont moches, le code est moche

If the comments are ugly, the code is ugly

Le développeur de "Plone"
Martin Aspeli
A expliquer un jour qu'un programmeur en C faisait part de trois règles apprises à ses dépens. Celle qui a particulièrement attiré l’attention de Martin (et la mienne) est la suivante :

Les bons programmes ne comportent aucune faute d’orthographe ni de faute de grammaire.

Je pense que cela vient probablement d’une attention soutenue aux moindres détails.

Dans les programmes excellents tout est correct à tous les niveaux, jusqu’aux points qui terminent les phrases de commentaires.

THE END