Skip to content

Commit

Permalink
corrected a few typos and expanded a few short-forms
Browse files Browse the repository at this point in the history
  • Loading branch information
guarang8 committed Mar 26, 2012
1 parent c3346bf commit 38f3e4a
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/CodeConventions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 38f3e4a

Please sign in to comment.