Sean O' Rourke wrote >On Fri, 4 Oct 2002, Tanton Gibbs wrote: >> I agree with this; however, I also think it would be nice to have it all in >> one place. It's a nuisance to have to open every file just to see what it >> is. By the time I figure out what the 60th file does, I've forgotten what >> the first does. It would be nice to have the information at the top of the >> file >> and then have a program pull it and create a separate file...that way they >> are always in sync. > >My thoughts exactly. Hopefully the boilerplate comment is regular enough >that this should be easy-ish to write.
I agree with all this. My first thought had been to have a seperate file containing the list, but that would prove difficult to maintain. So at the top of every file there'd be a summary like =file_summary filename description =cut Then this could be processed by a utility. As to the format for documentation, I don't think there's any format which is appreciably better, or worse than any other. I'm more familiar with JavaDoc than POD but I don't really see how /** Some Java documentation */ is any better than =pod Some POD documentation =cut Or maybe it'd be helpful to have a beginners guide to POD, for people who are more used to another languages doc style. Best Regards Mark Sparshatt
