I wind up writing a lot of infrastructure stuff, so over time I've internalized these questions:
- Is this as simple as I can make it?
- What are error conditions that I need to check?
- How can I break this? What happens if it breaks?
- How can I test this? If I can't test it, I need to rewrite it so it can be tested.
- How would another programmer want to use this? Whare are logical parameters and their order? What are logical return values?
- Is this coupled to anything else? If it relies on a constant, however assumable, can I put the constant in a configuration somewhere or make it available for modification?
- If nothign else works: what would clemburg do? (Plug in your own smart peer.)
Chris
M-x auto-bs-mode
-
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.
|