D&C GLug - Home Page

[ Date Index ] [ Thread Index ] [ <= Previous by date / thread ] [ Next by date / thread => ]

Re: [LUG] Code comments (was Linux @ University of Plymouth)

 

Ross Bearman wrote:
> I always found, and this might just me, but code explanations written
> as closely to pseudo code make a lot more sense. Definitely not just
> psuedo code, but I tend to try and be simplistic and black and white
> in most of my comments. When I'm reading other people code, I find it
> jarring when somebody who is clearly a good coder, but not so much a
> good writer, trying to explain a complex procedure using
> conversational language. When trying to explain a binary process, it's
> much simpler to explain it in simple terms as the computer sees it,
> rather than trying to bend the English language to your will.
>
> Regards, Ross Bearman
>   
I've tended to find that trying to teach a complex process is easiest 
done (and best understood) by explaining it this way too.

Grant.

-- 
The Mailing List for the Devon & Cornwall LUG
http://mailman.dclug.org.uk/listinfo/list
FAQ: http://www.dcglug.org.uk/linux_adm/list-faq.html