Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

Re: Perl Babysteps 1: Your First Simple Script

by Anonymous Monk
on Dec 30, 2004 at 09:57 UTC ( #418225=note: print w/ replies, xml ) Need Help??


in reply to Perl Babysteps 1: Your First Simple Script

Try to match the header complexity to the program, though. Using this header for a program that consists of one line of code might be a little bit of overkill. I usually start with the two-line header and expand it as I see fit.

Oh, I got to ask this. What will be the two lines you start with, and how large does your program need to grow before you add, say, the name of the author, a paragraph about usage, or a version on it? If you expand it, in which order do you add the things your example has?

Whether I slab on comments like author, version, date, usage, etc, on a program has all to do with the purpose and intended usage of the program. And nothing at all to do with its length.


Comment on Re: Perl Babysteps 1: Your First Simple Script
Re^2: Perl Babysteps 1: Your First Simple Script
by webfiend (Vicar) on Dec 30, 2004 at 19:31 UTC

    Thank you for the comment, that's a good point. I think my original intention was that the author should add the extra information when he expects other folks to take advantage of his script.

    Hmm ....

    But by that point juerd's suggestion about using POD becomes even more relevant. The long script header thing is really a digression from the main point, and has caused a little bit of bad blood in the threads already, so I think I will take that out completely.

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://418225]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others romping around the Monastery: (8)
As of 2014-09-21 18:59 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    How do you remember the number of days in each month?











    Results (175 votes), past polls