Beefy Boxes and Bandwidth Generously Provided by pair Networks
Just another Perl shrine
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

I see a difference between explaining what I'm doing to someone who was having difficulty with a fairly straightforward regexp, in the context of a learning environment, and producing clear, concise, readable code in a non-instructional environment. A novella to an experienced user may be useful guidance to someone with less familiarity on the topic.

It could also be said that YAPE::Regex::Explain produces too much explanation. Yet when it's requested, it's available. Should someone comment the trivial in a normal script (whatever normal means)? No. Could excessive comments be helpful in the context of describing how a specific segment of code works to someone who has requested instruction? Yes.

Anyway, the code and comments were provided with the intent of being helpful, and I believe that goal was probably accomplished.


Dave


In reply to Re^3: Regex to get everything before first / by davido
in thread Regex to get everything before first / by limzz

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (7)
As of 2024-03-28 12:51 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found