Accueil Formations Apprendre CSS 3

L'importance de commenter son code CSS

Retour à la formation
Chapitre 3 Leçon 1
Précédent
Suivant

Découvrez pourquoi il est crucial de commenter votre code CSS dès le début du projet.

Détails de la leçon

Description de la leçon

Commenter le code CSS est essentiel pour faciliter la compréhension et la maintenance du code par d'autres développeurs. Cela s'avère également utile pour vous, particulièrement si vous revenez sur votre projet après une période d'absence.

Il est conseillé de structurer et de commenter votre code dès le début. Indiquez à minima le nom de l'auteur, la date de création et la version du fichier. Cela est d'autant plus pertinent lorsque vous collaborez sur un projet.

En CSS, les commentaires se réalisent en encadrant le texte avec /* et */. Ces commentaires, invisibles pour les utilisateurs finaux, permettent d’ajouter des annotations qui n'affectent pas le rendu visuel du site.

Pour garantir la lisibilité et la compréhension internationale, il est recommandé de rédiger ces commentaires en anglais. Vous pouvez inclure des informations telles que votre nom, votre email, un lien vers votre site web, la date et la version du fichier. Ainsi, vous assurez une bonne communication des intentions et des modifications apportées au code.

Objectifs de cette leçon

L'objectif de cette vidéo est de vous apprendre comment commenter votre code CSS efficacement pour améliorer la maintenance et la collaboration.

Prérequis pour cette leçon

Pour suivre cette vidéo, il est recommandé de connaître les bases du langage CSS.

Métiers concernés

Commenter le code CSS est une compétence clé pour les développeurs front-end, les intégrateurs web, et toute personne chargée de la maintenance et de la gestion de projets web complexes.

Alternatives et ressources

Comme alternatives, vous pouvez utiliser des outils de documentation automatiques ou des frameworks CSS avec une structure prédéfinie qui inclut des commentaires détaillés.

Questions & Réponses

Commenter le code CSS est important pour faciliter la compréhension et la maintenance par d'autres développeurs ou par soi-même après une période d'absence.
En CSS, un commentaire commence par /* et se termine par */.
L'anglais étant une langue internationale, rédiger les commentaires en anglais facilite la compréhension par le plus grand nombre de développeurs.