> From: "Eric Engler"
> > http://www.mpeforth.com/arena/lpcforth.zip
>
> Wow, your documentation is the best I've seen for any Forth system.
Blush! Thanks. For the last five or six years we've done all our
new manuals using a literate programming system called DocGen.
All documentation be put in the source files themselves. DocGen
is part of VFX Forth for Windows. It's similar in some ways to
Doxygen, but more designed from the perspective that it *must*
be easy to use otherwise programmers won't bother. The lcc
sources convinced us of that!
One major benefit of this is that generating new manuals for
different implementations is little more than writing Forth
scripts naming a set a files. All the documentation is inherited
from the source files themselves.
Another major benefit is that because it is easy to write
formatted manuals, programmers adapt their work pattern and
write the documentation as they go. This in turn leads to
improved code quality in our experience.
As you can gather, I'm a fan of literate programming systems.
Stephen
--
Stephen Pelc, s...@mpeforth.com
MicroProcessor Engineering Ltd - More Real, Less Time
133 Hill Lane, Southampton SO15 5AF, England
tel: +44 (0)23 8063 1441, fax: +44 (0)23 8033 9691
web: http://www.mpeforth.com - free VFX Forth downloads
Yahoo! Groups Links
Free Forth for LPC2xxx
Started by ●March 28, 2006