Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

Re: Re: Documenting code

by ajt (Prior)
on Mar 14, 2003 at 13:20 UTC ( #243014=note: print w/ replies, xml ) Need Help??


in reply to Re: Documenting code
in thread Documenting code

I tend to agree with fever. I'm dyslexic and I find coloured text much harder to read than simple well spaced text. Plus coloured text is expensive to print in colour and when printed in B&W it looses contrast when compared with plain B&W text.

I've tried lots of syntax highlighting tools for code, HTML and XML, and I often find I think it's cool and better than plain unadorned text, until I use it, then I prefer light text (one of only a few colours) on a dark background.

The various societies for dyslexia, blind/partial sighted and reading/learning problems, all have guidelines (often conflicting I might add), but they tend to suggest simple high contrast colours well spaced.

While I accept that you can do what you want on your own when you work on code, when you present it, indeed when you present anything, it's all about clear simple presentation. The same rules that make an article or presentation good apply to anything, code or not.

For example:


--
ajt


Comment on Re: Re: Documenting code

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others examining the Monastery: (11)
As of 2014-12-26 18:45 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    Is guessing a good strategy for surviving in the IT business?





    Results (174 votes), past polls