FAQ PerlConsultez toutes les FAQ

En Perl, comme dans tous les langages de programmation, il est recommandé d'insérer des commentaires pour une meilleure clarté. Le commentaire commence à partir d'un caractère dièse (#) s'étend jusqu'à la fin de la ligne (retour chariot). Mais, cette ligne ne commence pas nécessairement par dièse comme le montre l'exemple ci-dessous.

1
2
3
4
5
6
#!/usr/bin/perl 
use strict; 
use warnings; 
  
# Voici une ligne de commentaire. 
print "Bonjour\n"; # Affichage du mot bonjour (autre commentaire).

Il est vrai que le mécanisme de commentaires commençant par un dièse (#) et se terminant à la fin de la ligne manque de souplesse, notamment dans le cas où l'on souhaite commenter de larges blocs de code. Dans ce cas, il est possible de détourner un mécanisme avancé de Perl qui est conçu pour permettre d'avoir des scripts contenant leur propre documentation : POD (Plain Old Documentation - Bonne Vieille Documentation - très utile par ailleurs).

Les directives POD =for et begin/=end permettent de créer facilement de larges blocs de texte qui seront ignorés par le compilateur et qui ne produiront pas non plus d'effet visible lorsque le fichier sera traité par un formateur POD. Ces instructions constituent donc un moyen très pratique d'insérer des portions de documentation interne dans vos sources.

La directive =for est identique à une paire begin/=end, la seule différence étant que la documentation ne concerne qu'un paragraphe, dont la fin est matérialisée par une ligne vide. Il est obligatoire d'ajouter la directive =cut pour indiquer au compilateur que la documentation est terminée et qu'il doit reprendre l'analyse de la source Perl.

Évitez la forme =begin/=end, sauf dans le cas où les explications sont abondantes et sur plusieurs paragraphes ou bien lorsque du code est inséré dans ces explications.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
$i=5; # ici, ce code est interprété 
=for mon commentaire: 
blablabla 
blablabla 
blablabla 
  
=cut 
# mon code 
#... 
  
=for autre commentaire: 
blablabla 
blablabla 
blablabla 
  
=cut 
  
=begin test: 
blablabla 
blablabla 
  
blablabla 
blablabla 
  
for (1..12) { 
  say $_; # plus adequate 
} 
  
=end test 
  
=cut 
  
print $i."\n"; # mais l'interprétation reprend ses droits, ici même.

• perldoc pod (sous Windows) ;
• Documentez vos modules Perl avec Pod.
  

Il existe de nombreuses manières d'ajouter des commentaires ou de mettre en commentaire du code en utilisant POD, le système de documentation de Perl.

Méthode rapide (mais pas très propre) de mettre en commentaire du code:

1
2
3
4
5
6
7
8
9
 
 
=pod 
 
    ... Lignes de code à mettre en commentaire ... 
    ... doivent être indentées ... 
    ... La ligne "=cut" ci-dessous doit se trouver complètement à gauche et être précédée et suivie d'une ligne blanche 
 
=cut

1
2
3
4
5
6
7
8
9
10
11
12
 
 
=for comment Une ligne de commentaire (qui n'apparaîtra pas dans les HTML ou autres documents générés à partir du POD) 
 
=cut 
 
... 
 
=for comment 
La ligne de commentaire peut également être repoussée à la ligne 
 
=cut

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
=for comment Un commentaire 
de plusieurs 
lignes. 
 
=cut 
 
... 
 
=for comment 
Un commentaire 
de plusieurs 
lignes. 
 
=cut

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
=for comment 
 
Lignes du 
premier paragraphe 
 
Paragraphe 
suivant 
 
... 
 
Dernier 
paragraphe 
 
=cut

commenter