I like my code laid out in a particular way, but your section on Code Layout really clamps down on a particular style. I'm not sure if it's going to be worth the effort that make absolutely sure that everyone's following exactly the same format.
A better approach is somewhere between 'I like to format my code like this' and 'I'm making changes to some existing code so I'm going to modify my coding style so the new code doesn't clash too much with the old code'
For me, a code review is more about 'is it readable and maintainable?' than 'is the one correct true style being followed?'
Alex / talexb / Toronto
"Groklaw is the open-source mentality applied to legal research" ~ Linus Torvalds
-
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.
|