Làm thế nào để sử dụng ý kiến trong Perl mã

Chương trình thực hiện mã của máy tính. Nhưng tôi viết mã này và bổ sung cho mọi người. Máy tính vẫn như phức tạp và phức tạp mã — nó chỉ là sẽ thực hiện. Nhưng nếu mã dễ dàng để hiểu được để người đàn ông, nó sẽ dễ dàng hơn và nhanh hơn để hoàn thành và nó sẽ ít sai lầm.

Ý kiến trong chương trình này là văn bản dành cho sử dụng con người. Máy tính, không sử dụng ý kiến. Mục tiêu của xét để làm cho mã, rõ ràng hơn cho con người. Ý kiến tất cả thời gian trong chương trình mã, khi một người cần phải thay đổi đoạn mã, nó đọc xét và được ông đơn giản hóa sự hiểu biết về những gì đang xảy ra mã.

Mục tiêu thứ hai của xét là một công cụ khi phát triển mã. Thường viết mã có một mảnh mà không cần thiết, nhưng rất sớm, bạn sẽ cần. Trong trường hợp này, các mảnh nó là thuận tiện để thảo luận ra mã cho đến khi chạy-gỡ lỗi mã tiếp theo. Khi kết thúc công việc những nhận xét ra từng mảnh của mã không nên ở lại.

Một dòng ý kiến

Để viết một bình luận trong những Perl ngôn ngữ bạn cần để đặt pound #. Tất cả mọi thứ sau này biểu tượng cho sự kết thúc của dòng sẽ là một bình luận.

Các biểu tượng mảng có thể là khởi đầu của dòng:

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

Hoặc ở phía trước của lưới có thể là khoảng trống:

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

Và xét có thể đi sau khi mã:

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

Xem xét có thể viết ngay sau khi các bảng biểu tượng, nhưng để có thể đọc, bạn nên đặt một không gian sau khi #

#comment without a space
# comment with a space

Nếu băm là bên trong chuỗi, nó không phải là một đánh giá, như một phần của một chuỗi:

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

Cấu hình editor

Khi đó là một công việc hoạt động trên danh dự án đó cần một bình luận ra một vài dòng mã.

Nó rất thuận tiện để cấu hình ảnh được càng nhiều càng tốt. Ví dụ: để làm cho các biên tập làm việc như thế này:

  • đánh dấu tất cả các dòng bạn muốn thảo luận ra
  • nhấn vào Ctrl+/
  • kết quả là ở phía trước của tất cả các đường đó là lựa chọn biểu tượng xuất hiện #

Nhiều đường ý kiến

Trong mã chương trình Perl có thể được viết tài liệu. Nó sử dụng một đặc biệt ngôn ngữ đánh dấu POD (nó là viết tắt của Đồng tài Liệu). POD thiết kế đặc biệt để để viết văn bản cho con người trong chương trình mật mã.

Đây là một ví dụ POD đánh dấu vào các tài liệu về phương pháp:

=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 đánh dấu luôn luôn bắt đầu bằng =, sau đó không có không gian là chỉ Thị. Ví dụ =head2 hoặc =item. Biểu tượng = phải luôn luôn được ở đầu hàng. Nếu ông sẽ không gian, nó sẽ không làm việc.

POD đánh dấu luôn luôn kết thúc với một chỉ Thị =cut. Và trước khi nhân vật = cũng nên không có khoảng trống.

Sử dụng nhiều dò ý kiến cho tạm thời loại bỏ mã

Nếu bạn làm việc trên một dự án bạn sẽ cần phải tạm thời bình luận ra một đoạn mã cho này bạn có thể sử dụng kỹ thuật này. Trước khi mã bạn muốn nhận xét bạn cần phải viết =a, và sau khi mã =cut:

my $str = 'AB';

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

Tất cả những gì được viết giữa =a=cut sẽ được ẩn từ Perl thông dịch viên.

Nhưng đó là một quyết định mà không bị bỏ lại trong chương trình mật mã. =a là không hợp lệ POD chỉ Thị và khác nhau POD phân tích cú pháp sẽ cung cấp cho các lỗi khi làm việc với mã trong đó có như vậy không đúng POD.

Các bài viết khác