3 ms·

Are there tools/IDEs where you can attach screenshots or sketches to code (source files)? More integrated than a README with images, ideally. I understand the

by Tempest1981 3y ago

Are there tools/IDEs where you can attach screenshots or sketches to code (source files)? More integrated than a README with images, ideally. I understand the out-of-date concern... still interested in how it might work. Feels like something that probably existed in the 90s as part of some bespoke ecosystem.

deleted 3y ago
[deleted]
rightbyte 3y ago
HolyC is the only one I know about ...
mbork_pl 3y ago
Probably not what you have in mind, but Org-mode can do it (more or less). And if there's a place this is implemented already (or will be soon), I would bet on DrRacket. Still, an interesting idea. I'm more of a text guy than a visual learner, but I agree that comments in the form of images could be very useful. The problem I can envision with this is that whoever adds such a feature to some IDE/environment would probably run with it and add sound and video comments, too, and then it will be like XML: making sense in theory, but horribly abused 99% of the time...
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 ago
  here'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.

deleted 3y ago

[deleted]

rightbyte 3y ago

HolyC is the only one I know about ...

mbork_pl 3y ago

Probably not what you have in mind, but Org-mode can do it (more or less). And if there's a place this is implemented already (or will be soon), I would bet on DrRacket. Still, an interesting idea. I'm more of a text guy than a visual learner, but I agree that comments in the form of images could be very useful. The problem I can envision with this is that whoever adds such a feature to some IDE/environment would probably run with it and add sound and video comments, too, and then it will be like XML: making sense in theory, but horribly abused 99% of the time...

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 ago
here'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.