For me, I have only written POD when I intended to publish the module. As some others have said, it would be an unnecessary interruption to the code which does not give me any useful information. I prefer to comment the code with things I need to remember.

For finding sections of my code, I use a heading, via comments, but one that is large and easy to see when scrolling quickly past it. This can be as simple as something like this for a function...

# ------------------------------------------------------------- # P R O C E S S R E P L A C E M E N T S # -------------------------------------------------------------
...or with my HTML code to be able to easily find a section there...
<!-- #^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^ # ******* S T A R T O F J A V A S C R I P T S H E R E ! ! ! **** +*** #_____________________________________________________________________ +____ -->
...to something more noticeable for a group of functions or a section of HTML, like this:
<!-- #^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ # ******* N E W A C C O U N T C R E A T I O N ******* #________________________________________________________ ----- +----- 1 | H | +|He | |---+---- -------------------- ++---| 2 |Li |Be | | B | C | N | O | F +|Ne | |---+---| |---+---+---+---+--- ++---| 3 |Na |Mg |3B 4B 5B 6B 7B | 8B |1B 2B |Al |Si | P | S |Cl +|Ar | |---+---+---------------------------------------+---+---+---+---+--- ++---| 4 | K |Ca |Sc |Ti | V |Cr |Mn |Fe |Co |Ni |Cu |Zn |Ga |Ge |As |Se |Br +|Kr | |---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+--- ++---| 5 |Rb |Sr | Y |Zr |Nb |Mo |Tc |Ru |Rh |Pd |Ag |Cd |In |Sn |Sb |Te | I +|Xe | |---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+--- ++---| 6 |Cs |Ba |LAN|Hf |Ta | W |Re |Os |Ir |Pt |Au |Hg |Tl |Pb |Bi |Po |At +|Rn | |---+---+---+------------------------------------------------------- +----- 7 |Fr |Ra |ACT| ------------- -------------------------------------------------------- +----- Lanthanide |La |Ce |Pr |Nd |Pm |Sm |Eu |Gd |Tb |Dy |Ho |Er |Tm |Yb +|Lu | |---+---+---+---+---+---+---+---+---+---+---+---+---+--- ++---| Actinide |Ac |Th |Pa | U |Np |Pu |Am |Cm |Bk |Cf |Es |Fm |Md |No +|Lw | -------------------------------------------------------- +----- -->
(Yes, I found that text art online somewhere and copied it...too much work to make it myself!)

Sometimes my header can be removed once active development on that section is complete. It just helps me find it at the time I am working with that section.

These headers have been my way of navigating my code more easily, as each of the 20+ files in the required codebase has over 1,000 lines on average.

Blessings,

~Polyglot~


In reply to Re: Where to place POD by Polyglot
in thread Where to place POD by Bod

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • 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, details, 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, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.