Cómo utilizar los comentarios en el código de Perl

El código de programa del ordenador. Pero escribir y complementan el código de la gente. Equipo todo es igual a lo complejo y enredado código — él simplemente se ve. Pero si el código es fácil de entender a la persona, es más fácil y rápido de completar, y en él se menos errores.

Los comentarios en el programa es un texto diseñado para los seres humanos. El equipo no utiliza comentarios. La tarea de los comentarios para hacer el código más comprensible para los humanos. Los comentarios están en el código del programa, cuando una persona debe cambiar el fragmento de código, lee el comentario y es simplifica él la comprensión de lo que sucede en el código.

El segundo objetivo de los comentarios es un instrumento para el desarrollo de código. A menudo — escribes el código, hay un fragmento que ahora no es necesario, pero muy pronto va a necesitar. En este caso, este fragmento el código es conveniente comentar, hasta que запускаешь-отлаживаешь código de cerca. Cuando el trabajo termina tales закомментированных trozos de código no debe permanecer.

Los comentarios de una sola línea

Para escribir un comentario en el lenguaje de programación Perl es necesario poner el símbolo de la almohadilla #. Después de este carácter hasta el final de la línea será de un comentario.

El símbolo de la rejilla puede ser en el principio de la línea:

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

O delante de la parrilla pueden ser espacios:

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

Y también el comentario puede ir después del código:

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

El comentario puede escribir inmediatamente después del símbolo de la parrilla, pero para facilitar la lectura vale la pena poner un espacio después de #

#comment without a space
# comment with a space

Si el símbolo de la almohadilla se encuentra dentro de la línea, esto no es un comentario, a parte de una cadena:

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

El editor de configuración

Cuando está trabajando activamente en el proyecto es la necesidad de comentar varias líneas de código.

Es muy cómodo configurar un editor de texto para hacer lo más fácil posible. Por ejemplo, puede hacer que el editor ha trabajado de esta manera:

  • distingues todas las filas que desea comentar
  • presionas Ctrl+/
  • el resultado es antes de todas las líneas que se han asignado aparece el símbolo de #

Los comentarios multilínea

En el código de Perl del programa, se puede escribir de la documentación. Para ello, se utiliza un lenguaje de marcado POD (es el acrónimo de Plain Old Documentation). POD está especialmente diseñado para escribir un texto para la persona en el código del programa.

He aquí un ejemplo de POD marcado con la documentación sobre el método:

=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 marcado siempre comienza con un signo igual =, después de lo cual a la vez sin espacio va de la directiva. Por ejemplo =head2 o =item. El símbolo de = debe ser siempre en el principio de la línea. Si antes que él, se espacios en blanco, esto no funcionará.

POD marcado siempre termina de la directiva de la =cut. Y antes de que el símbolo de la = , también, que no debe tener espacios.

El uso de los comentarios de varias líneas para evitar cortando el código

Si al trabajar en el proyecto necesita temporalmente comentar algún trozo de código, para ello se puede utilizar esta técnica. Antes del código que desea comentar la necesidad de escribir =a, y después del código de =cut:

my $str = 'AB';

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

Todo lo que está escrito entre =a y =cut se oculta en el intérprete de Perl.

Pero es una decisión que no se puede dejar en el código del programa. =a no es валидной POD directiva y diferentes analizadores POD generarán errores en el código que contiene un incorrecto POD.

Otros articulos