Beefy Boxes and Bandwidth Generously Provided by pair Networks
Syntactic Confectionery Delight
 
PerlMonks  

comment on

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

I understand the tension between too-much modularity and not enough. It's a continuing part of self-aware coding.

Moving more of your code into modules with POD documentation will help make subroutines less burdensome.

Using modules lets you group your code into specific name spaces, and when you use explicit imports, you have an instant reminder where the sub came from.

Using POD lets you use perldoc to read about your code.

Consider this code:

use MyMod qw( foo ); foo( $somearg, $another, 57, 'bunnies' );

I know that foo() comes from MyMod, so I can simply do a perldoc MyMod, to read about foo().

This beats the heck out of:

require './mylib.pl'; foo( $somearg, $another, 57, 'bunnies' ); # mylib.pl
Escpecially since if I refactor MyMod or mylib, and move foo() to another file, failure to update the location info in my code causes a fatal error for the module. With library requires, I can easily get stuck with comments that lie.


TGI says moo


In reply to Re^3: How's My Style Now? by TGI
in thread How's My Style Now? by Spenser

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 sharing their wisdom with the Monastery: (3)
As of 2024-04-24 20:43 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found