From 38f3e4add5b8341f9d289a38d96f17306a67e587 Mon Sep 17 00:00:00 2001 From: Manish Date: Mon, 26 Mar 2012 22:20:54 +0530 Subject: [PATCH] corrected a few typos and expanded a few short-forms --- docs/CodeConventions.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/CodeConventions.txt b/docs/CodeConventions.txt index 8ec82e529b8..f01072085c7 100644 --- a/docs/CodeConventions.txt +++ b/docs/CodeConventions.txt @@ -30,8 +30,8 @@ File Organization: - imports - javadoc comment - class or interface or enum definition - - static vars - - instance vars + - static variables + - instance variables - constructors - ruby declarations - getter and setter methods @@ -50,7 +50,7 @@ Comments: Use plain english for all of your comments. - Add only meanful javadoc comments (do not leave meanless IDE-generated + Add only meaningful javadoc comments (do not leave meaningless IDE-generated comments in your code). The first sentence shall sumarize the element's purpose but must not simply rephrase the element's name. Add more sentences if you need to add further description and/or examples. Try @@ -89,9 +89,9 @@ Statements: Use one statement per line. - Use curlies {} always. Put the { at the end of the line. Put } always + Use curly braces {} always. Put the { at the end of the line. Put } always in a new line. An else or catch or finally statement shall be put on the - same line as the closing }. + same line as the closing }. Do not use superfluous (), especially not with return.