如何使用的意见在Perl码

该程序代码由计算机执行。 但我写这些代码和补充的人。 计算机仍然是复杂的和复杂的密码—这只会执行。 但是,如果代码很容易理解的人,它会更容易和更快的完成,并将它 少犯错误。

意见在程序中的文本意在于人类使用。 计算机不能用 评论意见。 审查的目的使代码的更明确的人. 评论意见所有的时间 在程序代码,当一个人需要改变的代码,就读的审议和是 他简化的理解什么是发生在码。

第二个目标的审查是一个工具在发展中的代码。 通常编写代码 还有一块这是不必要的,但很快你会需要。 在这种情况下,该片段 很方便地评论了代码,直到运行调试代码下。 当工作结束 这些注释说明的代码不应停留。

单行意见

写一个评论在Perl编程语言,你需要把英镑 #. 一切之后,这个符号来底线将是一个评论。

符号阵列可以在开始的线:

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

或者在前面的栅可方面的差距:

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

和审查可以去后码:

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

审查可以写后立即磅的符号,但为便于阅读,你应该把空间后 #

#comment without a space
# comment with a space

如果哈里串,它不是一个审查部分作为一串:

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

配置的编辑

当有一个活跃的工作在该项目有一个需要评论了若干行的代码。

这是非常方便配置的文本编辑器应尽可能容易。 例如 做的编辑工作,这样的:

  • 强调所有的线路,你想要评论了
  • 点击 Ctrl+/
  • 结果是在面前的所有行其所选定的符号似乎 #

多行评论意见

在代码Perl程序可以是书面文件。 它使用一种特殊标记语言POD (它代表着纯的旧文档). 荚专门设计的 编写的案文人在程序的代码。

这里有一个例子POD标记的文档有关的方法:

=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};
}

荚标记的开头总是与相等 =,在这之后没有空间是指令。 例如 =head2=item. 符号 = 必须始终在开始行。 如果他会 空间,它不会的工作。

荚标记总结束一项指令, =cut. 和之前的字 = 也不应方面的差距。

使用多评论,对暂时删除码

如果你的一个项目的工作,你需要暂时评论了一块代码 你可以使用这种技术。 代码之前你想要发表评论你需要编写 =a, 和后代码 =cut:

my $str = 'AB';

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

所有这一切都写之间 =a=cut 将被隐藏从Perl的解释。

但它是一个决定,不能在程序的代码。 =a 是不是一个有效的POD指令 和不同的POD分析程序会得到错误当作用的代码,其中包含诸如不正确的。

其他文章