[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Axiom-developer] literate programming in html
From: |
Ralf Hemmecke |
Subject: |
Re: [Axiom-developer] literate programming in html |
Date: |
Fri, 20 Jan 2012 12:59:52 +0100 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:8.0) Gecko/20111124 Thunderbird/8.0 |
On 01/20/2012 11:57 AM, Martin Baker wrote:
Does the code have to be physically in the same document as the documentation
to achieve the aims of literate programming?
It all depends on your tools. If there were a tool that puts every code
chunk into a separate file but while editing shows you the chunks in the
order you want, you wouldn't care how your content is physically stored.
A tool that can show (maybe even different) views on code and
documentation would certainly be optimal. Anyway, I think one of the
important view is that a potential reader can understand the code and
the ideas (theory) that the code builds on. So the "literate programmer"
also has the task to linearize thoughts and help others to understand
the program.
Different views on the program is another helpful feature, but without
also restructuring the accompanying documentation, it would not belong
to the world of LP.
LP doesn't say how things have to be stored. In only says that you
embellish your documentation with nice constructive examples (the actual
code).
(Traditionally, we embellish programs by documentation.)
Ralf