2011-04-06 David Levin <levin@chromium.org>
authorlevin@chromium.org <levin@chromium.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 7 Apr 2011 01:04:30 +0000 (01:04 +0000)
committerlevin@chromium.org <levin@chromium.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 7 Apr 2011 01:04:30 +0000 (01:04 +0000)
        Reviewed by Ojan Vafai.

        Augment style guidelines about meaningless parameters from text the unwritten rules email.
        https://bugs.webkit.org/show_bug.cgi?id=55275

        * coding/coding-style.html:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@83127 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Websites/webkit.org/ChangeLog
Websites/webkit.org/coding/coding-style.html

index c17f144fc4bd3f7773b04a01de4bec98d8811365..aebd25ce40d78147c9f439658db73607e6a62933 100644 (file)
@@ -1,3 +1,12 @@
+2011-04-06  David Levin  <levin@chromium.org>
+
+        Reviewed by Ojan Vafai.
+
+        Augment style guidelines about meaningless parameters from text the unwritten rules email.
+        https://bugs.webkit.org/show_bug.cgi?id=55275
+
+        * coding/coding-style.html:
+
 2011-04-05  Yury Semikhatsky  <yurys@chromium.org>
 
         Unreviewed. Add Web Inspector stack trace, pause on exception and window.onerror
index aab6d5796ff75f84bb3bdd5306136632fc5444c2..4331aaf1212289c8cb03454216a6f9d46a911299 100644 (file)
@@ -587,15 +587,19 @@ bool toASCII(short*, size_t);
 </pre>
 </li>
 
-<li>Leave meaningless variable names out of function declarations.
+<li>Leave meaningless variable names out of function declarations. A good rule of thumb is if the parameter type name contains the parameter name (without trailing numbers or pluralization), then the parameter name isn't needed.  Usually, there should be a parameter name for bools, strings, and numerical types.
 <h4 class="right">Right:</h4>
 <pre class="code">
 void setCount(size_t);
+
+void doSomething(ScriptExecutionContext*);
 </pre>
 
 <h4 class="wrong">Wrong:</h4>
 <pre class="code">
 void setCount(size_t count);
+
+void doSomething(ScriptExecutionContext* context);
 </pre>
 </li>