in reply to Re^3: RFC: Any and all comments welcome on style/technique in new module to calculate G statistic (rather)
in thread RFC: Any and all comments welcome on style/technique in new module to calculate G statistic
Personally, I advocate and use the same documentation style as you use in this module. I don't know how common it is either, but the greatest advantage is that documentation and code are in the same place. If the interface or the pre- or postconditions change in the code, it is easy to update them in the documentation: the documentation is just over there, hard to miss.(Here's one gripe: document your internal methods, too. Put them under =head1 INTERNAL FUNCTIONS or somesuch, then use podselect to remove them from the official documentation, if it matters.)
True, without syntax highlighting it's harder to make a visual difference between code and documentation, but I don't think this is a big issue. Your eye will get used to noticing the "code sections" between =cut and =head and "documentation sections" between =head and =cut.
It's not ideal, but it's the best I have found.
print "Just Another Perl Adept\n";