LOG4315, Atelier de génie logiciel

Norme de programmation pour pages HTML

Version 1.0

2005-02-01

François Lemieux
Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

Historique des modifications du document

Date Version Description Auteur

2005-01-28 1.0 Création François Lemieux

École Polytechnique de Montréal, 2005 Page 2 de 8

Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

Table des matières

1 Introduction 4
1.1 Objectif du document 4
1.2 Portée du document 4
2 Noms de fichier 5
2.1 Suffixes de nom de fichier 5
2.2 Noms de fichier usuels 5
3 Organisation des fichiers 5
3.1 Fichiers HTML. 5
3.2 Fichiers de feuilles de style 5
3.2.1 Commentaires d’ouverture 6
3.2.2 La liste des classes 6
3.2.3 Les classes 6
3.3 Fichiers de code Javascipt 6
3.3.1 Commentaires d’ouverture 6
3.3.2 La liste des fonctions 6
3.3.3 Les fonctions 7
4 Indentation 7
4.1 Longueur de ligne 7
4.2 Lignes distribuées 7
5 Commentaires 7
6 Pratiques de programmation 7
6.1 Gérer la mise ne page avec des tableaux 7
6.2 Prescription des cadres 8
6.3 Prescription des témoins 8

École Polytechnique de Montréal, 2005 Page 3 de 8

Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

Norme de programmation pour pages HTML

1 Introduction
Le présent document propose certaines règles de programmation pour le langage HTML. Il précise les règles fixées
par la norme HTML 4.01 telle que définie par le W3C lors de sa recommandation du 24 décembre 1999 disponible
en version française à l’adresse : http://www.la -grange.net/w3c/html4.01

1.1 Objectif du document

Ce document définit des normes portant sur la programmation de en langage HTML dans le cadre de projets logiciels utilisant
des composants web.

1.2 Portée du document

Les normes ne couvrent pas les normes de programmation pour les pages Java Server. Les normes portent plus spécialement sur
les noms de fichier et leur organisation, l’indentation, les commentaires, les déclarations, les instructions, les expressions,
l’espace blanc, les conventions de nommage et les pratiques de programmation.

École Polytechnique de Montréal, 2005 Page 4 de 8

Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

2 Noms de fichier
Cette section énumère les noms et suffixes de noms de fichier habituellement utilisés.

2.1 Suffixes de nom de fichier

Java utilise les suffixes de nom de fichier suivants :

Type de fichier Suffixe

Page HTML .html

.jsp
.jspf

Code javascript .jsp

Feuille de style .css

2.2 Noms de fichier usuels

Le nom de la page d’accueil du site doit être index.html ou index.jsp.

Le nom des fichiers est écrit en lettres minuscules

3 Organisation des fichiers

Un fichier est constitué de sections qui doivent être séparées par des lignes blanches et un commentaire identifiant
chaque section. Les fichiers ne doivent pas dépasser 2000 lignes de code.

3.1 Fichiers HTML.

Les fichiers HTML ont la même organisation que les fichiers JSP tel que décrit dans la norme de programmation
pour pages Java Server.

3.2 Fichiers de feuilles de style

Les fichiers .css définissent les classes de style qui seront utilisées dans les pages HTML. La structure du fichier
doit être la suivante :
1 Commentaires d’ouverture
2 Lis te des classes
3 Les classes

École Polytechnique de Montréal, 2005 Page 5 de 8

Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

3.2.1 Commentaires d’ouverture

Tous les fichiers source commencent avec un commentaire de type langage C qui identifie le nom de la classe, les
informations sur la version, la date et la note de copyright.
<!--
* Nom de la feuille :
*
* Date de dernière modification :
*
* Date de création :
*
* Notes de copyright
-->
3.2.2 La liste des classes

Énumérer par ordre alphabétique la liste des classes incluses dans le fichier. La liste peut être présentée sur plusieurs
colonnes afin d ’en faciliter la lecture.

3.2.3 Les classes

Séparer chaque classe par un commentaire descriptif de quelque mots qui commence par l’adresse électronique de
l’auteur et la date de cération. Par exemple :
<!—prenom.auteur@polymtl.ca -- 2005-02-01 --
Mise en forme d’un titre de chapitre-->
3.3 Fichiers de code Javascipt

Les fichiers .js définissent les fonctions javascript qui seront utilisées dans les pages HTML et JSP. La structure du
fichier doit être la suivante :
1 Commentaires d’ouverture
2 Lis te des fonctions
3 Les fonctions
3.3.1 Commentaires d’ouverture

Tous les fichiers source commencent avec un commentaire de type langage C qui identifie le nom de la classe, les
informations sur la version, la date et la note de copyright.
/*
* Nom de la feuille :
*
* Date de dernière modification :
*
* Date de création :
*
* Notes de copyright
*/
3.3.2 La liste des fonctions

Énumérer par ordre alphabétique la liste des fonctions incluses dans le fichier. La liste peut être présentée sur

École Polytechnique de Montréal, 2005 Page 6 de 8

Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

plusieurs colonnes afin d’en faciliter la lecture.

3.3.3 Les fonctions

Séparer chaque fonction par un commentaire descriptif de quelques mots qui commence par l’adresse électronique
de l’auteur et la date de création et ajouter sur les lignes suivantes, une description des paramètres et des valeurs de
retour. Par exemple :
/* prenom.auteur@polymtl.ca -- 2005-02-01 –
* Fonction qui affiche un chronomètre
*
* Paramètres :
* - Un entier qui donne le nombre de minutes à chronométrer
*
* Retour
* - Un entier qui indique la fin du chronométrage
*/
4 Indentation
L’unité d’indentation est de 4 espaces. L’indentation doit être en caractères ASCII d’espace.

4.1 Longueur de ligne

Une ligne ne doit pas avoir plus de 70 caractères

4.2 Lignes distribuées

Utiliser la pratique de définie pour la programmation en langage Java. Une expression qui ne tient pas dans une
ligne doit être distribuée selon les principes suivants :
§ Privilégier le saut de ligne de haut niveau
§ Aligner la nouvelle ligne avec le commencement de l’expression au même niveau que la ligne précédente.
• Lorsque les règles précédentes entraînent un code confus, indenter de 8 caractères
5 Commentaires
Il y a peu de commentaires dans et ils sont utilis és pour distinguer les sections tels que défini dans la norme de
programmation pour pages Java Server pour les commentaires côté client et les b locs de commentaires pour lignes
multiples .

6 Pratiques de programmation
6.1 Gérer la mise ne page avec des tableaux

Toutes la mise en page doit être incluse dans des tableaux.

École Polytechnique de Montréal, 2005 Page 7 de 8

Norme de programmation pour pages HTML Version : 1.0

Date : 2005-02-01

6.2 Prescription des cadres

L’utilisation des cadres (frame ) est prohibée.

6.3 Prescription des témoins

L’utilisation des témoins (cookie) est prohibée.

École Polytechnique de Montréal, 2005 Page 8 de 8