aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Landley <rob@landley.net>2014-06-07 12:03:54 -0500
committerRob Landley <rob@landley.net>2014-06-07 12:03:54 -0500
commitd0c0422e601226101d28e954a4fc974d78a139eb (patch)
tree3040effb16bf320f64aa40bfed7279e28fedae2f
parent2682551a4b192d566383afcdd57081fd222656ed (diff)
downloadtoybox-d0c0422e601226101d28e954a4fc974d78a139eb.tar.gz
Minor tweaks to code style section.
-rwxr-xr-xwww/design.html10
1 files changed, 6 insertions, 4 deletions
diff --git a/www/design.html b/www/design.html
index 0db57ed2..c9944e3a 100755
--- a/www/design.html
+++ b/www/design.html
@@ -372,15 +372,17 @@ to spot as overrides to the normal flow of control, which they are.</p>
<p>When there's a shorter way to say something, we tend to do that for
consistency. For example, we tend to say "*blah" instead of "blah[0]" unless
we're referring to more than one element of blah. Similarly, NULL is
-really just 0 (and C will automatically typecast 0 to anything),
-"if (function() != NULL)" is the same as "if (function())",
-"x = (blah == NULL);" is "x = !blah;", and so on. (The goal is to be
+really just 0 (and C will automatically typecast 0 to anything, except in
+varargs), "if (function() != NULL)" is the same as "if (function())",
+"x = (blah == NULL);" is "x = !blah;", and so on.</p>
+
+<p>The goal is to be
concise, not cryptic: if you're worried about the code being hard to
understand, splitting it to multiple steps on multiple lines is
better than a NOP operation like "!= NULL". A common sign of trying to
hard is nesting ? : three levels deep, sometimes if/else and a temporary
variable is just plain easier to read. If you think you need a comment,
-you may be right.)</p>
+you may be right.</p>
<p>Comments are nice, but don't overdo it. Comments should explain _why_,
not how. If the code doesn't make the how part obvious, that's a problem with