주석을 사용하는 방법에 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+/
  • 결과는 앞에 모든 라인을 선택한 기호가 나타납니다 #

Multi-line 댓글

코드에서는 Perl 프로그램을 작성할 수 있습 documentation. 사용 특수한 마크업 언어 POD (약자에 대한 일반 오래된 문서 참고). 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};
}

POD 태그의 시작과 동등한 =,후에는 아무 공간은 지시어. 예를 들어 =head2 또는 =item. 호 = 항상해야에서의 시작을 행합니다. 는 경우 그는 것입니다 공간,그것은 작동하지 않습니다.

POD 태그의 끝은 언제나 함께 Directive =cut. 전자 = 도하지 않아야 합니다.

사용이 여러 줄에 대한 의견을 일시적으로 제거하는 코드

만약 당신이 작업 프로젝트에서 당신이 일시적으로 주석 코드를 이 당신이 기술을 사용합니다. 기 전에 코드를 작성해야 =a, 과 후에 코드 =cut:

my $str = 'AB';

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

모든 것은 쓰는 사 =a=cut 로부터 숨겨져 있을 것입니다.Perl 인터프리터입니다.

하지만 그것을 결정할 수 없는 왼쪽에서 프로그램 코드입니다. =a 유효하지 않은 창 Directive 과 다른 POD 파서는 오류가 발생한 때로 작동 코드를 포함하는 이러한 잘못된니다.

다른 기사