Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Re: Re: Inline POD vs. EOF POD

by particle (Vicar)
on Jul 09, 2001 at 18:26 UTC ( #94985=note: print w/ replies, xml ) Need Help??


in reply to Re: Inline POD vs. EOF POD
in thread Inline POD vs. EOF POD

The problem with POD is that it's darn ugly. I appologize, I don't wish to badmouth it, but it really just is ugly :-)

YES!!! not fifteen minutes ago was i muttering about the ugliness of POD. i'm in the final phase of a project for my current client, and i'm reviewing all the code and making sure the docs are updated as i turn everything over to the admin team. i use CodeWright for my editing, which does wonders to make perl code pleasant to look at, but does nothing to make pod code readable. i haven't taken the time to modify the lexer to color-code POD code, but i think i'll do just that after this job.

but POD is ugly. i place mine at the end while i'm coding, because i hate to look at it. when i'm done with a program, usually i'll move it inline so whoever's maintaining the code is more likely to update the doc. (although i have no proof that putting the POD inline increases the likelyhood of maintenance, i do it anyway.)

i tend to use well named variables and functions, and code comments to document my code. typically, i also generate detailed design documentation. sometimes i use pod to generate this, but lately i've found myself writing the doc and then cut/pasting the text into the script as pod. there, i've said it... pod's so ugly, i use Word instead! ACK. i feel dirty.

~Particle


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

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (6)
As of 2015-07-02 23:56 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

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









    Results (47 votes), past polls