* Kelly Jones ([EMAIL PROTECTED]) [061125 00:54]: > I'm using POD to document some Perl code-- a library w/ a bunch of > functions. > .. > It takes 5 lines of POD to document one line of code? Ouch! > > That's a lot of screen real estate when viewing the file in emacs. > Is there a shortcut? Can I make this work somehow?:
IMO, the amount of user documentation is always much larger that the perl program itself. Therefore, I think it is really fundamental (for any programming language) to make docs easy to use but also easy to create (less work, reduced chances on mistakes). I have tried to stir the community a little up to get some extensions in, but people were reluctant. This resulted in the OODoc module, which requires a small effort to set-up but then gives you a whole lot of benevits. See chapter DETAILS in http://search.cpan.org/~markov/OODoc-0.95/lib/OODoc/Parser/Markov.pod It produces real POD and much nices HTML than pod2html; see http://perl.overmeer.net/mailbox/html/ In that distribution, OODoc saved me typing of about 700.000 characters, I recently calculated. That's time for a lot of beers. I am sorry to say that the POD for Perl6 will be very verbose to write as well... extended discussions with Damain didn't help. Documentation will stay a second class citizen; not integrated with the language and verbose. -- Regards, MarkOv ------------------------------------------------------------------------ Mark Overmeer MSc MARKOV Solutions [EMAIL PROTECTED] [EMAIL PROTECTED] http://Mark.Overmeer.net http://solutions.overmeer.net
