|
Literate programming is a certain way of writing computer programs which combines documentation and source code into one file. The compilable source code and the formatted documentation can be extracted from this file with specific utilities. The main idea is to regard a program as a communication to human beings, as works of literature, hence the name. The documentation is organized as a cross-linked web of documented code sections whose order may differ from the one in the compilable program. |
|
Literate programming is a certain way of writing computer programs which combines documentation and source code into one file. The compilable source code and the formatted documentation can be extracted from this file with specific utilities. The main idea is to regard programs as communications to human beings, as works of literature, hence the name "literate programming". The documentation is organized as a cross-linked web of documented and numbered code sections whose order may differ from the one in the compilable program. |
|
These however do not quite follow the literate programming philosophy since their documentation output does not contain the source code itself. |
|
These however do not quite follow the literate programming philosophy since they typically just produce documentation about the program, such as specifications of functions and parameters, and not documentation of the program source code itself. |
![[Home]](wikipedia.png)