3 ms·
When writing code, use Literate Programming. Not JavaDocs-style API documentation, but actually explain what your code is doing and why inside the code itself.
by bergie 16y ago
When writing code, use Literate Programming. Not JavaDocs-style API documentation, but actually explain what your code is doing and why inside the code itself. When explaining stuff you will be able to catch bugs before even running the code.
And as bonus, you'll have documentation that isn't a burden to maintain.
Docco or Noweb are good tools for this. Here is one of my Docco examples:
http://bergie.github.com/VIE/ http://bergie.github.com/VIE/