Comment utiliser les commentaires dans le code Perl

Le code d'un programme se fait par l'ordinateur. Mais écrire et à compléter le code de gens. L'ordinateur est toujours autant difficile et compliqué de code, il suffit de exécutait. Mais si le code est facile à comprendre, alors il sera plus facile et plus rapide à compléter et il sera moins d'erreurs.

Les commentaires dans un programme est un texte destiné à l'homme. L'ordinateur n'utilise commentaires. La tâche de commentaires pour rendre le code plus lisible pour l'homme. Les commentaires sont dans le code d'un programme, lorsqu'une personne a besoin de modifier une partie du code, il lit un commentaire et c'est simplifie lui comprendre qu'il se passe dans le code.

La seconde tâche de commentaires est un outil lors de l'élaboration du code. Souvent — écrire du code, il y a un morceau qui maintenant n'est pas nécessaire, mais très vite besoin. Dans ce cas, cet extrait le code de pratique en commentaire jusqu'à ce que запускаешь-déboguez le code. Quand le travail se termine ces закомментированных morceaux de code ne doit pas rester.

Une ligne de commentaires

Pour écrire un commentaire dans le langage de programmation Perl, vous devez mettre un symbole #. Tous les après ce caractère, et à la fin de la ligne sera un commentaire.

Le symbole de la grille peut être au début de la ligne:

# This is a comment
my @arr = (1..10);

Ou devant les barreaux peuvent être des espaces:

foreach my $el (@arr) {
    # One more comment
    warn $el;
}

Ainsi que le commentaire peut aller, après le code:

my @arr = (1, 2, 3); # some description for @arr
my %h; # explanation of %h

Commentaire vous pouvez écrire immédiatement après le symbole dièse, mais pour faciliter la lecture de la peine de mettre un espace après #

#comment without a space
# comment with a space

Si le symbole de la grille se trouve à l'intérieur de la chaîne, ce n'est pas un commentaire, mais une partie de la ligne:

my $str = 'Line 1
# This is not a comment, but part of a string variable
Line 2';

Configuration de l'éditeur

Lorsqu'un travail actif sur le projet arrive à la nécessité de commenter plusieurs lignes de code.

Très pratique pour configurer un éditeur de texte pour qu'il puisse faire le plus simple possible. Par exemple, vous pouvez faire pour l'éditeur a travaillé à ça:

  • mets en relief toutes les lignes que vous souhaitez commenter
  • cliquez sur Ctrl+/
  • le résultat avant toutes les lignes qui ont été mis en évidence, le symbole apparaît #

Les commentaires sur plusieurs lignes

Dans le code Perl de programme, vous pouvez écrire de la documentation. Pour ce faire, on utilise un langage de balisage POD (c'est synonyme de Plain Old Documentation). Le POD est spécialement conçu pour écrire un texte pour une personne dans le code du programme.

Voici un exemple d'un POD de balisage de la documentation sur la méthode:

=head2 get_name

    my $name = $obj->get_name();

Returns the name of the Person stored in the object.

The return value is a scalar with length >= 1 and <= 100.

=cut

sub get_name {
    my ($self, @other) = @_;

    die 'get_name should not get any parameters' if @other;

    return $self->{_name};
}

POD le balisage commence toujours par le signe égal =, après lequel tout de suite, sans espace va directive. Par exemple =head2 ou =item. Le symbole de = doit toujours être au début de la ligne. Si devant lui seront des espaces, cela ne fonctionnera pas.

POD le balisage se termine toujours de la directive =cut. Et devant le caractère = aussi, ne doit pas contenir d'espaces.

L'utilisation de plusieurs lignes de commentaires temporaire pour effacer le code

Si vous travaillez sur un projet, vous devez temporairement commenter un morceau de code, pour cela vous pouvez utiliser une telle réception. Avant le code que vous voulez commenter le besoin d'écrire =a, et après le code =cut:

my $str = 'AB';

=a
foreach my $el (1..10) {
    parse_index($el);
}
=cut

Tout ce qui est écrit entre =a et =cut sera caché de l'interpréteur Perl.

Mais c'est une solution qui ne peut pas laisser dans le code du programme. =a n'est pas валидной POD la directive et les différents analyseurs POD délivrer des erreurs lors de l'utilisation avec le code qui contient un tel nombre de POD.

Autres articles