At 05:46 AM 11/11/2001, Stephen Adkins wrote: >Hi, > >What experiences to people have with using inline POD within >the Module.pm as opposed to maintaining two files, >Module.pm (for code) and Module.pod (for documentation)? >What recommendations would you have for P5EE code? > >I would assume Inline POD is the way to go. >I am wondering if anyone has experiences counter to this.
It depends if you are documenting a module/API or if you are documenting a way of doing something. In general, I think it is better to keep docs for the module close to the module. Meta data such as FAQs or guides line the mod_perl guide that aren't tied to specific modules should be standalone PODs. I could see a P5EE Blueprint similar to the J2EE Blueprint being a set of PODs in the same vein as the Mod_perl guide. Later, Gunther
