[Aldor-l] Literate programming

[pip88nl at gmail.com]

On Wed, Aug 20, 2008 at 09:10:07PM +0200, Ralf Hemmecke wrote:
> >I am currently on vacation in austria, so I will have limited time to
> >code, but I am working on backtrace.cc (from librona), making it a 
> >literate programming file.
> 
> What kind of vacation is that? ;-)

Personal, visiting my girlfriend :-). She's an actress and while she's
working, I will be coding.

> >I hope some of you can comment on my interpretation of literate
> >programming.
> 
> Maybe you could send some instructions on how to find your code.

http://xinutec.org/~pippijn/files/up/backtrace.cc.nw is my first literate
file. I feel very discontent about it, even considering the fact that
it's unfinished. Is this how literate programming is supposed to be?

> >By the way, as I see it, API documentation should be in POD and code 
> >documentation in LaTeX along with the code (as literate programs).
> >POD is excellent for API documentation. Am I seeing this right?
> 
> What would be wrong in also doing the API documentation in LaTeX? But I 
> guess, more important than the format is the content at the moment. One 
> can always reformat. So I would suggest do it in a way you are most 
> comfortable with.

I'm most comfortable with POD and second comfortable with C comments. I'm
not sure about it, yet. Maybe I will go with latex comments after all. At
least vim can do latex highlighting within comments.

Pippijn
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://mail.aldor.org/pipermail/aldor-l_aldor.org/attachments/20080820/1013abc2/attachment-0002.bin>