In general I lean towards less nesting. Less nesting makes the code easier to map into a model in my head. A lot of nesting in one place make me question if there should be a subroutine.
I have seen code with CLAIM comments that signal to the reader that something is true at that point in the program. (Well, that the programmer intended it to be and believes it to be true.) See the following example.
sub foo
{
my($self) = @_;
my $authentication = $self->authenticate_user();
if(! defined($authentication)){
return {status=>0, error=>"Authentication Failed", external_id=>
+undef};
}
# CLAIM : the user is authenticated
my $profile = $self->get_user_profile();
if(! $profile->is_active()){
return {status=>0, error=>"User is not active", external_id=>und
+ef};
}
# CLAIM : the user profile is active
my($external_id) = $self->find_external_id($profile);
if(! defined($external_id)){
$external_id = $self->send_profile_to_partner($profile);
}
# CLAIM : the user profile has been sent to the partner
return {status=>1, error=>undef, external_id=>$external_id};
}
-
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.
|