note
radiantmatrix
<p>I most wholeheartedly agree with the parent. I'd like to add, however, that a POD section granting an overview of the module is most helpful as well.
<p>Poke around on the CPAN docs -- many of the modules there are well-documented. Combine that style with that of [jplindstrom] above, and you have superb documentation that is both in-code and extractable using any one of the <tt>pod2</tt> tools.
<p>The existence of <tt>pod2html</tt> also means that your documentation will be intranet-publishable, which looks great to your project manager.
<!-- Node text goes above. Div tags should contain sig only -->
<div class="pmsig"><div class="pmsig-375088">
<font color='#0000d8'>r</font><font color='#0000b1'>a</font><font color='#00008a'>d</font><font color='#000063'>i</font><font color='#00003c'>a</font><font color='#000015'>n</font><font color='#000000'>t</font><font color='#000039'>m</font><font color='#000060'>a</font><font color='#000087'>t</font><font color='#0000ae'>r</font><font color='#0000d5'>i</font><font color='#0000fc'>x</font><font color='#000024'>
</font><br />
<tt><small>require General::Disclaimer;</small></tt>
</div></div>
396760
396796