4 ms·
36. Documentation Linked Code sounds like literate programming [1], which interleaves the source code with prose explanations. This idealized description is du
by mci 7y ago
36. Documentation Linked Code sounds like literate programming [1], which interleaves the source code with prose explanations. This idealized description is due to Peter J. Denning [2]:
> A literate program contains not only the needed statements in a programming language, but also a precise problem statement, a summary of the background needed to understand the solution, an evaluation of alternatives, assessments of trade-offs between the running time and space, or between running time and programming time, and suggestions on how to modify the program. Program code segments are inserted in the text at points logical to the intellectual development of the algorithm. A literate program pays careful attention to lucidity of presentation and presents all arguments needed to understand why the program will actually run as intended.
[1] https://en.wikipedia.org/wiki/Literate_programming https://en.wikipedia.org/wiki/Literate_programming
[2] https://www.cs.upc.edu/~eipec/pdf/p583-van_wyk.pdf https://www.cs.upc.edu/~eipec/pdf/p583-van_wyk.pdf
- user00012-ab 7y agoEmacs org-mode does this very well.