I think you've hit upon a very basic dilemma that most, if not all, good programmers have. I know that issue is something I struggle with as well.
My solution to the problem has been two-fold:
- I make sure that the first thing on the line is the "important" code.
- I sometimes line-break then indent my logging code, to further emphasize its subordinate status.
Here's an example:
# bad
log("This code is broken!") unless $obj->method_call(arg1 => 'abc', ar
+g2 => 123);
# good
$obj->method_call(arg1 => 'abc', arg2 => 123)
or log("This code is broken!");
I'm not saying my way is the One True Way, but that's what I do and it works for me.
---
It's all fine and dandy until someone has to look at the code.
-
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.
|