Margin Notes: Automatic code documentation with recorded examples from runtime
This is a recorded version of a talk presented at the LIVE 2018 workshop at SPLASH.
Read the interactive essay and try out Margin Notes: https://geoffreylitt.com/margin-notes/
Follow me on Twitter for further updates: / geoffreylitt
---
Programmers working on large codebases frequently need to understand APIs for existing code. Manual documentation is helpful, but takes time to maintain and often doesn’t include enough examples.
Margin Notes automatically generates code documentation by recording example data from function calls as a program executes and displaying those examples in an interactive UI next to the code. This allows programmers to quickly view many examples from past executions as they read the code, helping them efficiently gain insight into the behavior of the program.