Comments

Jump to bottom Edit New page

Mikhail Panko edited this page Aug 29, 2013 · 2 revisions

Add at least minimal comments while you write code. Modularity and good notation greatly reduce the amount of required comments.

A short description of each function’s purpose at the beginning
A few words in front of each block of meaningful computation
Reference sources for your methodology/notation when applicable (articles, Wikipedia, etc)
Too many comments are better than too few
(Bonus) specify function’s inputs and outputs thoroughly

Check out the wiki repository for examples.