Octavian Rasnita wrote:
> 
> From: "John W. Krahn" <[EMAIL PROTECTED]>
> 
>> Octavian Rasnita wrote:
>>
>>> ----- Original Message ----- From: "sivasakthi" <[EMAIL PROTECTED]>
>>>
>>>> How to comment Multiple lines  in Perl?
>>>
>>> Perl doesn't have a multiline comment mark.
>>>
>>> You can use perldoc marks in order to comment what you want, or include 
>>> the content in a string, like:
>>>
>>> Perldoc style:
>>>
>>> =start
>>> Here
>>> are the
>>> lines you
>>> want to comment
>>> =cut
>>
>> $ echo "
>>
>> =start
>> Here
>> are the
>> lines you
>> want to comment
>> =cut
>>
>> " | podchecker
>> *** ERROR: Unknown command 'start' at line 3 in file <standard input>
>> <&STDIN does not contain any pod commands.
>>
>
> I know that =start is not a valid POD command, but it doesn't break the 
> program. When I use it, I don't need to use it to add real POD docs, so the 
> commands shouldn't be valid.
> 
> =head1 NAME
> is too long...

(Once again, please bottom-post replies to this group. It maintains readability
for extended threads. Salutations and signatures should always be edited out.
You are responsible for the whole of your post, not just your own material.)

There are many things that "don't break the program" but are far from good
programming practice. Start by taking out all whitespace, for example.

When we think there is very little chance of our code being read by someone else
or processed in a way we didn't anticipate, the World will surprise us. Being
nice to the people who expect our program to be Pod-clean is part of the Perl
ethos, and should be honoured.

Neither

  =start

nor

  =comment

are valid POD, and

  =head1 NAME

is even worse, because it means something that you don't intend.

The documentation that John referred you to recommends

  =begin comment
    :
  =end

Which may be a trifle awkward, but I'm sure there are worse things that happen
to you in your day. It takes less than a second to type, and if you do it a lot
you could set up a macro in your editor.

As a last resort you could make a case for not being nice to people and we will
consider it here.

HTH,

Rob




-- 
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
http://learn.perl.org/


Reply via email to