And don't add pointless comments like<br><br>' the next line adds A and B<br><br>And a module should begin with remarks to give info such as<br>- module name & version<br>- author<br>- date of last change<br>- known issues<br>
- work still to do<br> <br><br><div class="gmail_quote">On 4 May 2012 09:34, Ben Hines <span dir="ltr"><<a href="mailto:b.hines@ccg.vic.edu.au" target="_blank">b.hines@ccg.vic.edu.au</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div link="blue" vlink="purple" lang="EN-AU">
<div>
<p class="MsoNormal">Hey List!<u></u><u></u></p>
<p class="MsoNormal"><u></u><u></u></p>
<p class="MsoNormal">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…<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">Any ideas? <u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><b><span style="color:#1f497d">Mr Ben Hines</span></b><b><span style="font-size:12.0pt;color:#1f497d"><u></u><u></u></span></b></p>
<p class="MsoNormal"><span style="color:#1f497d"><u></u> <u></u></span></p>
<p class="MsoNormal"><i><span style="color:#1f497d">VCE Maths/ICT Teacher<u></u><u></u></span></i></p>
<p class="MsoNormal"><i><span style="color:#1f497d">Senior School Campus - Christian College Geelong<u></u><u></u></span></i></p>
<p class="MsoNormal"><span style="font-family:Wingdings;color:#1f497d">(</span><span style="color:#1f497d"><a href="tel:%2803%29%2052411577" value="+61352411577" target="_blank">(03) 52411577</a> (ext. 180)<u></u><u></u></span></p>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>
<br>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.<br>
<br><hr size="1">Message protected by MailGuard: e-mail anti-virus, anti-spam and content filtering.<br><a href="http://www.mailguard.com.au" target="_blank">http://www.mailguard.com.au</a><br>
<br> <br><br>_______________________________________________<br>
<a href="http://www.edulists.com.au" target="_blank">http://www.edulists.com.au</a> - FAQ, Subscribe, Unsubscribe<br>
IT Software Development Mailing List kindly supported by<br>
<a href="http://www.vcaa.vic.edu.au" target="_blank">http://www.vcaa.vic.edu.au</a> - Victorian Curriculum and Assessment Authority and<br>
<a href="http://www.vcaa.vic.edu.au/vce/studies/infotech/softwaredevel3-4.html" target="_blank">http://www.vcaa.vic.edu.au/vce/studies/infotech/softwaredevel3-4.html</a><br>
<a href="http://www.vitta.org.au" target="_blank">http://www.vitta.org.au</a> - VITTA Victorian Information Technology Teachers Association Inc<br>
<a href="http://www.swinburne.edu.au/ict/schools" target="_blank">http://www.swinburne.edu.au/ict/schools</a> - Swinburne University<br></blockquote></div><br><br clear="all"><br>-- <br>Mark Kelly<br>Manager of ICT, Reporting, IT Learning Area<br>
McKinnon Secondary College<br>McKinnon Rd McKinnon 3204, Victoria, Australia<br>Direct line / Voicemail: +613 8520 9085, Fax +613 9578 9253<br><a href="mailto:kel@mckinnonsc.vic.edu.au" target="_blank">kel@mckinnonsc.vic.edu.au</a> (don't use my Edumail account!)<br>
VCE IT Lecture Notes: <a href="http://vceit.com" target="_blank">http://vceit.com</a><br>Moderator: IT Applications Edulist<br><br>--<br>An E-flat, a C, and a G go into a bar. The bartender says, "I'm sorry, but I can't serve minors."<br>
<br><br>