jmeter-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Jmeter Wiki] Update of "CodeStyleGuidelines" by ham1
Date Sat, 11 Nov 2017 23:44:38 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Jmeter Wiki" for change notification.

The "CodeStyleGuidelines" page has been changed by ham1:
https://wiki.apache.org/jmeter/CodeStyleGuidelines?action=diff&rev1=5&rev2=6

Comment:
Added JavaDoc guidance

  
    * "Hard" maximum line length of 120 characters
     * Except for imports or other places where breaking the line wouldn't aid readability
-   
+ 
  
  === Spacing ===
  
@@ -36, +36 @@

     * `methodCall(arg1, arg2) {`
     * `String s = "con" + "cat";`
   * Braces are always used with `if`, `else`, `for`, `do` and `while` statements, even if
the body is empty or only a single statement
+ 
+ === JavaDoc ===
+ 
+  * Parameter descriptions are aligned and '''not''' on new lines.
+  * No invalid tags
+  * No tags without a description
+  * Blank line after main description but not after any tags
  
  === Other ===
   * Import order
@@ -52, +59 @@

    * Return types where null is possible (which aren't performance critical)
   * Default/static methods on Interfaces
   * Utilise lambdas where possible (max ~5 lines)
-   * If the lambda is >4-5 lines then consider making this a separate method
+   * If the lambda is >3 line then consider making this a separate method
  
  == See Also ==
  

Mime
View raw message