Having some POD to give a summary of things the test file is supposed to verify is a good suggestion. (As it is, in fact, a good idea to have such a summary in any non-trival Perl source file.)

I’d be worried to find extensive documentation for individual test cases, though. Writing individual tests so complex as to require documentation strikes me as unwise. They should be too trivial to usefully document. Instead, you should strive to give your tests good names. (I suppose you could make test names also show up in POD by keeping them there using the <<'=cut' trick.)

If you’re using a framework like Test::Class to group tests, such groups would be more useful to document traditionally.

Makeshifts last the longest.

In reply to Re: document your test files by Aristotle
in thread document your test files by shmem

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.