The debugger perl5db.pl is a good counterexample to this thesis.
It has a big command loop where the users input is read and the documentation for each command is interspersed for each command section.
The documentation will show up in the same order like programmed and must stay at this chronological position.
This makes refactoring the code extremely difficult. Frankly it's a PITA.
I'm a fan of interspersed function docs with POD, but
- only use it for external documentation.
- don't make code position dependend on it
- remember subs can be moved, linear code normally can't
(addicted to the Perl Programming Language :)
Wikisyntax for the Monastery
|Replies are listed 'Best First'.|
Re^3: Section Dividers - What are your thoughts (POD antipattern)
by Anonymous Monk on Jun 08, 2020 at 09:34 UTC
by LanX (Cardinal) on Jun 08, 2020 at 09:54 UTC
by Anonymous Monk on Jun 08, 2020 at 11:16 UTC
by LanX (Cardinal) on Jun 08, 2020 at 12:41 UTC