in reply to Inline POD vs. EOF POD
If enough of us will use inline POD, it will become more standard, and editors will accomodate for it.
To improve readability, what about adding some lines before and after POD comments, like:
################## POD documentation begin ####### =pod B<fetch_paper()> Retrieves paper from environment and returns it. Should be wrapped in an C<eval{}> to catch errors. Returns: L<My::Paper> object. =cut ################## POD documentation end ####### sub fetch_paper { my ( $self ) = @_; ... }
Avoiding to 'commute' between sub code and doc comments is exactly the 'good' lazines we highly esteem, right?
Update:I also agree that sometimes the order of inline POD doc might be not the most beneficial, and sometimes info might belong to more than one module. I do not know yet how to solve this.
One of possible solution (for CGI applications) might be to use CGI::Application, which allows to wrap multiple programs as "run modes" into one module. Then, I can write sub in order as it makes sense in documentation.
As I said, I do not have solution, only weak preferences.
That is why I wnat to listen to insight from other monks, to see that other questions meight be asked, and what I forgot to consider.
What a great place is our monastery!
pmas
To make errors is human. But to make million errors per second, you need a computer.
|
---|
Replies are listed 'Best First'. | |
---|---|
Re: Re: Inline POD vs. EOF POD
by mugwumpjism (Hermit) on Aug 16, 2001 at 03:03 UTC | |
by pmas (Hermit) on Aug 16, 2001 at 07:24 UTC | |
by mugwumpjism (Hermit) on Aug 16, 2001 at 11:58 UTC |