[Year 12 SofDev] Query about Internal Documentation

[Travis Parker]

I make my kids live by this mantra: "Don't include a single line in your
code which you could not explain to your grandmother in a matter of two
minutes."

 

I'm not sure of any set rules for internal documentation, just a
sensible explanation of what the code is doing in that particular spot.

 

Cheers

 

Trav

 

 

 

 

From: sofdev-bounces at edulists.com.au
[mailto:sofdev-bounces at edulists.com.au] On Behalf Of Ben Hines
Sent: Friday, 4 May 2012 9:34 AM
To: sofdev at edulists.com.au
Subject: [Year 12 SofDev] Query about Internal Documentation

 

Hey List!

 

Just wondering what the standards/conventions are for internal
documentation (Comments). Are there any or do we just teach our students
to sensibly comment sections of code with a little explanation of what
the code is achieving. The main thing I learnt at uni was when
commenting don't go too overboard with explanations...

 

Any ideas? 

 

Mr Ben Hines

 

VCE Maths/ICT Teacher

Senior School Campus - Christian College Geelong

((03) 52411577 (ext. 180)

 



Scanned by the Netbox from Netbox Blue <http://netboxblue.com/>  


This e-mail is intended for the use of the named individual or entity
and may contain confidential and privileged information. Any
dissemination, distribution or copying by anyone other than the intended
recipient of this e-mail is strictly prohibited. If this e-mail has been
received in error, then please notify Christian College or the author of
this email immediately and destroy the original message. We have made
every attempt to ensure this e-mail message is free from computer
viruses however the attached files are provided on the basis that the
user assumes all responsibility for use of the material transmitted.
Views, opinions, etc. expressed reflect those of the author and not
Christian College nor its associated companies and campuses which
includes Eden Quality Services Pty Ltd.

________________________________

Message protected by MailGuard: e-mail anti-virus, anti-spam and content
filtering.
http://www.mailguard.com.au
 
 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.edulists.com.au/pipermail/sofdev/attachments/20120504/57c05c18/attachment.html