in reply to Does PerlMonks do general code reviews?

So you are seeking wisdom regarding how well your Perl code is written? Yeah, we have a section for that.

For 500 lines of code, be sure to use <readmore> tags around the code. You might even want to put the bulkiest part of the module into a reply to the root node so it doesn't get in the way of people wanting to scan the thread.

Note that I've seen people using <spoiler> tags to act like <readmore> tags and I find such annoying. However, using <spoiler> tags around such large code in a root node makes more sense. But I think the code in <readmore>s in a reply will work even better, especially if you want to post updated versions for further review.

- tye        

Replies are listed 'Best First'.
Re^2: Does PerlMonks do general code reviews? (seek)
by Argel (Prior) on Jul 30, 2007 at 18:19 UTC
    You are assuming default behavior for spoiler tags. There are actualy several options that affect how spolier tags are rendered: "(default)", link, div, span, table, and reveal. The table view just puts dark text over a black background (in a table). The code is not collapsed or linked to in table view. That makes spoiler tags entirely inappropriate for large bodies of code, especially in root nodes. This seems like a classic example of misuing a feature without understanding the consequences. The readmore tag was designed to deal with large bodies of code and that is what should be used.

      That actually did cross my mind. I should have mentioned it (I was more concentrating on how best to use READMORE and mentioned my annoyance with misusing SPOILER as an aside). The full implications didn't "click". That is a much better reason to avoid trying to use SPOILER in place of READMORE than the ones that annoyed me. (:

      - tye