(no title)
drpixie | 2 months ago
A good start would be just commenting code! Almost all the code I've looked into recently has been startling - the only comments are the licence boilerplate at the top of each file!
I can think of only one product/library/package that was commented to explain what was happening. Go look at the source for a random package that you depend on. If you're really lucky, there might be something hinting at the meaning of function arguments, but like as not, not even that ;(
WillAdams|2 months ago
https://www.goodreads.com/review/list/21394355-william-adams...
The main website for this of course lists some resources:
http://literateprogramming.com/
most notably:
http://literateprogramming.com/adventure.pdf
(the source code of the venerable Colossal Cave Adventure re-worked as a Literate Program by Dr. Donald Knuth)