Beefy Boxes and Bandwidth Generously Provided by pair Networks
go ahead... be a heretic
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??
There isn't an official style document but perlstyle offers some advice on naming conventions, and there are some other conventions:
  • Module names are MixedCaseNoUnderscores
  • Constants are UPPERCASE_WITH_UNDERSCORES
  • Package wide variables are Mixed_Case_With_Underscores
  • Function variables are lowercase_with_underscores
Also, function and method names are also lowercase_with_underscore

This isn't complete or in any way authoritive, but in my opinion it's a good start. Take a look at the modules which are in the Perl distribution. They mostly follow the conventions listed above.

TVSET makes some good comments about the readability of your code.

If your code is readable, and you're consistent in whatever naming convention you use, you'll have maintainable code. If you're planning on putting modules on CPAN, then examine some of the more well-known modules (like DBI and LWP) to see what the naming conventions are.

Arjen


In reply to Re: Re: Perl Naming Conventions by Aragorn
in thread Perl Naming Conventions by Anonymous Monk

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 chilling in the Monastery: (7)
As of 2024-04-25 15:00 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found