Commentaire (informatique) - Définition

Introduction

En programmation, les commentaires sont des portions du code source ignorées par le compilateur ou l’interpréteur, car ils ne sont pas nécessaires à l’exécution du programme.

Les commentaires sont le plus souvent utilisés pour expliquer le code ; certains outils permettent d’extraire l’information disponible dans les commentaires pour générer automatiquement la documentation du programme.

On utilise aussi les commentaires pour masquer du code, mais aussi pour préciser des contraintes ou des propriétés, notamment des préconditions, des postcondictions et des invariants comme cela se fait dans la programmation par contrat.

Types de commentaires

Les façons de distinguer les commentaires du reste du code varient suivant le langage. On distingue trois catégories principales, chaque langage pouvant très bien implémenter plusieurs types de commentaires :

• commentaires en pleine ligne ;
• commentaires de fin de ligne ;
• commentaires en bloc.

Commentaires en pleine ligne

Un commentaire en pleine ligne commence par un marqueur annonçant une ligne de commentaire (ou par l’absence d’un marqueur annonçant une ligne de code). BASIC, Fortran et Cobol sont des langages utilisant des commentaires en pleine ligne. Le code recommence naturellement à la ligne suivante.

• BASIC :

REM commentaire

• Brainfuck et Brainfork :

commentaire

(le commentaire ne doit pas contenir les caractères < > + - , . [ ] ; c’est un exemple d’annonce par absence de marqueur)

• Cobol :

000010*COMMENTAIRE

(l’astérisque doit se trouver en 7^e position sur la ligne)

• Fortran :

C      commentaire

(exactement 6 espaces entre le caractère C et le commentaire ; C doit absolument être le premier caractère de la ligne)

• REALbasic :

rem commentaire

// commentaire

' commentaire

• PASCAL :

(* commentaire *)

// commentaire Pour dialectes Delphi et Free Pascal

• Bash :

# commentaire

Commentaires de fin de ligne

Un commentaire de fin de ligne commence par un marqueur annonçant le début d’un commentaire, et se termine automatiquement à la fin de la ligne, sans nécessité de marqueur de fin. Les langages C++ et Java utilisent ce type de commentaires.

• Ada (langage), AppleScript, Lua, Lingo, Haskell :

--commentaire

• Assembleur :

; commentaire

• BASIC :

' commentaire

• C (C99), C++, C#, D, Delphi (Pascal objet), Java et PHP :

// commentaire

• DCL :

$! commentaire

• Fortran 90 :

! commentaire

• mySQL :

--commentaire

#commentaire

• Perl, Python, Ruby, C shell, Bourne shell, Tcl, et autres langages shell :

# commentaire

• PHP :

#  commentaire

// commentaire

• PILOT :

R:commentaire

(une lettre de commande peut débuter immédiatement après le commentaire, sur la même ligne)

• TeX, LaTeX, PostScript :

% commentaire

• Texinfo :

@c commentaire

@comment commentaire

• Visual Basic :

' commentaire

• REALbasic :

' commentaire

// commentaire

• VHDL :

-- commentaire

Commentaires en bloc

Un commentaire en bloc commence par un marqueur annonçant le début d’un commentaire et se termine avec un marqueur annonçant sa fin, leur intérêt principal est de pouvoir mettre en commentaire plusieurs lignes sans éditer chacune d'entre elles. Les langages Pascal et C utilisent ce type de commentaires.

• Algol :

comment commentaire;

• AppleScript, Modula-2, Modula-3, Oberon, Pascal et Caml:

(* commentaire *)

• C (K&R, ANSI/C89/C90/C99), C++, C#, CSS, Java, PHP et PL/I :

/* commentaire */

• Forth :

(commentaire)

• D :

/* commentaire */

/+ commentaire +/

• Delphi (Pascal objet) :

(* commentaire *)

{  commentaire  }

• Haskell :

{- commentaire -}

• SGML, HTML, XML :

Commentaires de fin de fichier

Un commentaire de fin de fichier commence par un marqueur annonçant que tout ce suit, jusqu’à la fin du fichier, doit être considéré comme un commentaire. ATS est un exemple de langage utilisant ce type de commentaires.

• ATS :

//// commentaire