I happened to be flipping through my copy of Steve McConnell's Code Complete yesterday. He has a lot of material on how to name variables and functions that parallel and expand on Ovid's comments here. McConnell also discusses how to document and format code effectively, how to design modules with the appropriate amounts of coupling and cohesion, even what kind of "personal character" traits make for effective programmers. Some of it may cover familiar ground, but I find it's good material to review periodically.
$perlmonks{seattlejohn} = 'John Clyman';
-
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.
|