4 ms·
I wrote Private Comments[1] specifically to address this problem in code. My coworkers can maintain context about how a given thing works months after the fact.
by masukomi 4y ago
I wrote Private Comments[1] specifically to address this problem in code. My coworkers can maintain context about how a given thing works months after the fact. I can't. So, I leave private comments throughout the code. Things they'd never want committed, but save me hours of re-leaning when next i encounter a given piece of code.
Currently has plugins for Vim (proof of concept) and Emacs (actually good). It'd be lovely if one of you folks would make a VSCode plugin for it. I've thoroughly documented the API and diagrammed the code flow you'd need[2], so that this would be as easy as possible to add to your favorite editor.
[1]: https://github.com/masukomi/private_comments https://github.com/masukomi/private_comments
[2]: https://masukomi.github.io/private_comments/ https://masukomi.github.io/private_comments/
- dotancohen 4y agoJetbrains used to have a terrific plugin for this. Unfortunately it is no longer maintained.