Beefy Boxes and Bandwidth Generously Provided by pair Networks
P is for Practical

Re: Inline POD vs. EOF POD

by tadman (Prior)
on Jul 09, 2001 at 18:03 UTC ( #94980=note: print w/ replies, xml ) Need Help??

in reply to Inline POD vs. EOF POD

I'd say the inline version is more likely to be maintained because the "commute time" between the function and the associated documentation is much shorter. If things are on the same screen, even the lazy are inclined to keep things in sync. If it's at some obscure location in the file, things might drift apart.

BTW, here's a quick macro for 'vi' for skipping to the POD documentation in a file:      vi '+/^=pod'
You could make this into an alias, such as 'vipod'. When it enters each file it runs the command to find the first line that begins with '=pod'. If you don't always use that tag, you can just search for the equals sign.

Comment on Re: Inline POD vs. EOF POD
Download Code

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others about the Monastery: (18)
As of 2015-07-29 13:13 GMT
Find Nodes?
    Voting Booth?

    The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...

    Results (263 votes), past polls