On Wed, 12 Sep 2007, Sumit Upadhyay wrote:

> Date: Wed, 12 Sep 2007 07:29:31 -0000
> From: Sumit Upadhyay <[EMAIL PROTECTED]>
> Reply-To:  <[email protected]>
> To:  <[email protected]>
> Subject: [twincling] mutli line comments in Perl
> 
> Hi all,
> 
> How to give multi line comments in perl.
> /*  .......  *\  doesn't work here.
> 
> # is for one line.
> 
> For those who don't know here is interesting article.
> http://www.perl.com/pub/a/2002/08/13/comment.html
> 
> thanks
> Sumit
> 

Ideally, Multi-line comments are required when one needs to explain a 
decision or an algorithm or quote some excerpt (say from a manual).

In reality, the serve to support author names !

The 'POD' approach of PERL with all documentation towards the end 
of the same file, is the best I have seen so far.

Intrestingly enough, C programmer's have multi-line comment facility
 /*
  ...
  */

Still, you will see that C++ style, single line comments are quite popular !

In some cases, comments are actually worse than no comment 
since they mislead !


At the end of the day, 
 - thoughtful variable and function naming
 - and high quality code is what matters !


thanks
Saifi.

Reply via email to