It's not a bad idea, but I'm not sure we necessarily need another area. Certainly any code post could contain commentary, in the form of comments or even POD.

Also, many monks provide extensive details in their more-thought out posts. Consider Ovid's Death to Dot Star! or chromatic's Common Regex Gotchas. Also, Dominus's home node provides links to his site, where he's mirrored many of his articles.

It takes a special combination of skills to be able to explain code and to craft it. These skills must be nurtured and deeloped if you're going to gain any decent respect from your peers. Or, at the very least, any respect from the person who has to maintain your code.

In other words, it's a discpline thing, a skill you'll develop as a programmer. Feel free to document your code as completely as necessary--especially if you're counting on bits, behaviors, or sublties of the language that might be confusing to inexperienced coders or lesser mortals.

In short, we should already be doing this, save perhaps in Ob-Fu, where working through the confusion is the learning exercise.

--f

In reply to Re: Code explanation area by footpad
in thread Code explanation area by damian1301

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.