There are modules that are intended for users that are developers,
and these may need very detailed technical documentation, or even
documentation about the implementation of certain features.
I doubt that very much. Except for use in a classroom, modules are
written to be used. Even if the users are developers. Not to be picked
apart and their implementation studied. gdb wasn't written
so people could study its implementation, was it? Sure, some people
using a module will maintain it. But it's only for hardly used modules
were maintainers are a significant number.
In general, I think POD syntax is the problem here, not the idea
of "inline" vs. "EOF" documentation. If POD syntax would waste less
screenspace, everybody would use "inline" POD for implementation-level
documentation.
Well, that's quite opposite of one of my reason not to use inline POD.
Changing the syntax of POD to use less screenspace doesn't solve the
problem of having the documentation in the same order as the subroutines.
What makes you think noone will bother about order of documentation as soon
as POD stops wasting screenspace?
-- Abigail
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Outside of code tags, you may need to use entities for some characters:
| |
For: |
|
Use: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
|
|
