HACKER Q&A
📣 glaucon

Show Code with Notes Alongside


Tell me about projects that allow code to be displayed on the left and notes about that code to be displayed on the right ?

I've seen this in the past but I can't find an implementation now.

Thanks.

EDIT: I should have said that the 'code on the left, notes on right thing' was overly prescriptive, as long as the notes and code are in columns and the notes sit alongside the relevant part of the code that's good as far as I'm concerned.


  👤 blondin Accepted Answer ✓
i have seen those in annotated javascript documentation. but it was the other way around. (comment on the left, and code on the right). they all seem to use docco[0] with the option to display comment in "parallel". the author of docco used it in their library underscore[1].

[0]: https://github.com/jashkenas/docco

[1]: https://underscorejs.org/docs/underscore-esm.html


👤 turtleyacht
Bret Victor's ideas about interaction computing from a development perspective:

http://worrydream.com/#!/LearnableProgramming


👤 abudabi123
The Dr Racket IDE has a Literate Programming feature. I guess you can give it a display template to relate code to commentary on a landscape orientation. There is the ancient CWEB tooling. The Emacs editor has code/comment jumping superpowers and you can have the display buffers oriented side-by-side C-x 3.