You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jmeter.apache.org by Apache Wiki <wi...@apache.org> on 2017/11/11 23:44:38 UTC
[Jmeter Wiki] Update of "CodeStyleGuidelines" by ham1
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 ==