Beefy Boxes and Bandwidth Generously Provided by pair Networks
more useful options
 
PerlMonks  

Re^3: Documentation: POD vs Comments (visual)

by JavaFan (Canon)
on Jul 22, 2011 at 09:21 UTC ( #916083=note: print w/ replies, xml ) Need Help??


in reply to Re^2: Documentation: POD vs Comments (visual)
in thread Documentation: POD vs Comments

"use syntax highlighting" is really a poor defense. I'd say that code that isn't readable without syntax highlighting is just that: unreadable. One doesn't always have the luxury of using the editor that's tuned to your preferences - you may be looking at someone elses screen. Or you're debugging some code on a box that only has vi. (And when I mean vi, I mean vi. Not some vi clone renamed to vi). Or you may be reading code outside an editor (more, git blame, ...). Some people don't even have the luxury of easily distinguishing between colours - or they need the black-on-white constrast; any other colour just won't do.

I always write my code assuming the next person looking at the code uses ed and a 80x24 glass monitor, knows my address, and is a sociopath who keeps his axes sharp.


Comment on Re^3: Documentation: POD vs Comments (visual)
Download Code
Re^4: Documentation: POD vs Comments (visual)
by LanX (Canon) on Jul 22, 2011 at 12:13 UTC
    I didn't say "use syntax highlighting", I just wanted to clarify from which perspective tye is looking at the issue.

    Cheers Rolf

Re^4: Documentation: POD vs Comments (visual)
by BrowserUk (Pope) on Jul 22, 2011 at 17:05 UTC
    "use syntax highlighting" is really a poor defense. I'd say that code that isn't readable without syntax highlighting is just that: unreadable. One doesn't always have the luxury of using the editor that's tuned to your preferences

    Can you imagine a doctor eschewing the use of a stethoscope, because one day he might encounter an emergency when he hasn't got it with him?


    Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
    "Science is about questioning the status quo. Questioning authority".
    In the absence of evidence, opinion is indistinguishable from prejudice.

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others contemplating the Monastery: (7)
As of 2014-09-18 06:53 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

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











    Results (108 votes), past polls