Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
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

Replies are listed 'Best First'.
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?
[johngg]: My daughter is incredibly jealous of my wife who got to see The Clash at Brixton many years ago. They went to see The Vaccines there recently.
[1nickt]: But the bands are even louder! I saw Spearhead (Michael Franti) at an outdoor show and had to walk a mile away to not feel pain in my chest! Babies were crying ... I asked the sound engineer why it was necessary to have the bass so loud and he laughed...
[Discipulus]: but the best i attended live was Mano Negra Patchanka at Forte Prenestino .. in 1990
[Corion]: Hmmm - Mano Negra or at least Manu Chao seem to put on a good live show. At least the one live CD I have from Manu Chao sounds good ;)
Discipulus feels the same jealousity of the johngg's daughter
[1nickt]: choroba I agree
[choroba]: Playing in a punk rock band for 20 years... my hearing is quite bad
[Corion]: I still have hopes to turn my godson and his two siblings into a punk band ;)
[Corion]: Their older sister just started piano but has been interested in drumming, which she should be able to start with 8 years or so)

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (12)
As of 2017-03-24 12:19 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    Should Pluto Get Its Planethood Back?



    Results (301 votes). Check out past polls.