develooper Front page | perl.perl6.internals | Postings from July 2002

Re: [PATCH] .dev files.

Thread Previous | Thread Next
From:
Josh Wilmes
Date:
July 17, 2002 17:40
Subject:
Re: [PATCH] .dev files.
Message ID:
200207180039.g6I0dnN9024165@galactic.hitchhiker.org

For what it's worth, I agree.  I think that when your documentation is 
tied to the structure of your source files, it only makes sense to put it 
IN the source files.

I don't think you can do literate programming half-way.  While I don't 
think literate programming is the right thing to do to produce 
well-organized design documentation (of the sort we're doing in the PDDs), 
it's a perfect way to do implementation documentation, of all sorts.

Moving .devs into our .c files would add a big block of POD at the 
beginning or the end.  So what?  Sounds good to me.

--Josh

At 11:39 on 07/17/2002 PDT, John Porter <johndporter@yahoo.com> wrote:

> 
> Tanton Gibbs wrote:
> > . . . That saves a person digging through
> > the .c file to find what they are looking for. 
> > Perhaps we could automatically update the .dev
> > file with the POD found in the .c file?
> 
> As someone else has already said, a better place
> for the .dev information might be inside the .c
> file itself.
> I for one find the separation unnatural,
> uncustomary, and de-sync-prone.
> Frankly I just don't see what it buys us.
> 
> -- 
> JohnDouglasPorter
> 
> 
> __________________________________________________
> Do You Yahoo!?
> Yahoo! Autos - Get free new car price quotes
> http://autos.yahoo.com



Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About