FAQ PerlConsultez toutes les FAQ

Nombre d'auteurs : 18, nombre de questions : 250, dernière mise à jour : 29 octobre 2015  Ajouter une question

 

Bienvenue sur la FAQ Perl. Cette FAQ a pour vocation de vous enseigner ou de vous faire revoir les notions élémentaires de ce fantastique langage. Perl est très utilisé dans différents domaines depuis la gestion système, le réseaux, l'administration de bases de données, le web (CGI), la bureautique, la conception d'interfaces graphiques ou des contextes scientifiques telle la bioinformatique. Nous espérons que cette FAQ vous sera d'une grande utilité.

Vous souhaitez participer à l'amélioration de cette FAQ, n'hésitez pas !! Commentez

Bonne lecture !


SommaireS'initier à PerlLes commentaires (3)
précédent sommaire suivant
 

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.

Code perl : Sélectionner tout
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).

Mis à jour le 4 mai 2005 djibril

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.

Code perl : Sélectionner tout
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.
Pour en savoir plus sur POD :

Mis à jour le 4 mai 2005 2Eurocents djibril Philou67430

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:

Code : Sélectionner tout
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

Pour ajouter une ligne de commentaire, utiliser le mot-clef =for comment :

Code : Sélectionner tout
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

Plusieurs lignes de commentaires :
Code : Sélectionner tout
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

Le commentaire peut également contenir plusieurs paragraphes:

Code : Sélectionner tout
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

Cette question/réponse est adaptée d'une FAQ sur le site PerlMonks (avec l'aimable accord de son auteur, Ken Cotterill).

Vous souhaitez commenter !

Mis à jour le 23 août 2015 Lolo78

Proposer une nouvelle réponse sur la FAQ

Ce n'est pas l'endroit pour poser des questions, allez plutôt sur le forum de la rubrique pour ça


Réponse à la question

Liens sous la question
précédent sommaire suivant
 

Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright © 2017 Developpez Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

 
Responsable bénévole de la rubrique Perl : djibril -