Application Documentation</li></li></ul><li>Common Excuses for no Comments<br /><ul><li>It takes too long, I don't have time to comment my code!
Stop being lazy! You can comment 8 hours worth of code in around 15 minutes.
The program/logic is simple, it doesn't need comments.
Stop being lazy! If everyone thought the same way the world would be very boring
If you comment it, it's more likely the developer that extends your functionality will comment their changes. </li></li></ul><li>Common Excuses for no Comments<br /><ul><li>I'm the only person that will every work on this code.
Since you can see the future, can I have lottery numbers?
As stated before, code you wrote 3 months ago seems like it was written by a strangers when you try to work on it again.</li></li></ul><li>Comment Styles<br /><ul><li>Each language has their own comment style.
Most frameworks will extend this comment styleor create their own commenting style
A project's commenting style should be choosen at the beginning of the project
All developers should be the “Comment Police” to make sure everyone is commenting and following the guidelines.
3rd party commenting syntax -JavaDoc, PyDoc</li></li></ul><li>Best Habits for Commenting<br /><ul><li>Don't comment code before you feel it's finalized.
Inaccurate comments are worse than having no comment
You don't have to comment your code before committing it to version control
Update comments for functionality you've changed. (Extend, bug fix)</li></li></ul><li>Best Habits for Commenting<br /><ul><li>Use English for comments! This is important!
Comments are not an English test, you don't need to use full sentences or correct grammar
Most programmers can understand enough English to read and write a simple comment. </li></li></ul><li>Questions?<br />
A particular slide catching your eye?
Clipping is a handy way to collect important slides you want to go back to later.