3 ms·
you might be interested in "literate programming", a technique pioneered by Donald Knuth. the idea is to write your code in steps, inserting notes and documenta
by woodrowbarlow 3y ago
you might be interested in "literate programming", a technique pioneered by Donald Knuth. the idea is to write your code in steps, inserting notes and documentation into each step. you can then use tools to "weave" (produce documentation) or "tangle" (produce runnable code).
note: to do this properly, it should involve more than just inserting notes into your code. you'll need to adapt the way you write and design your code too (for adding documentation to various intermediate states, rather than just the way it looks right now).
http://literateprogramming.com/knuthweb.pdf http://literateprogramming.com/knuthweb.pdf
http://literateprogramming.com/cweb_download.html http://literateprogramming.com/cweb_download.html
http://literateprogramming.com/tools.html http://literateprogramming.com/tools.html
- woodrowbarlow 3y agohere's a retroactively funny snippet from the original knuthweb paper: > I chose the name WEB partly because it was one of the few three-letter words of English that hadn't already been applied to computers.