Confirmed users
905
edits
QA SoftVision Team/Mobile/Robocop basic code guidelines: Difference between revisions
Jump to navigation
Jump to search
QA SoftVision Team/Mobile/Robocop basic code guidelines (view source)
Revision as of 09:57, 4 January 2013
, 4 January 2013→Basic Code Guidelines that need to be followed for positive reviews
| Line 3: | Line 3: | ||
=== Basic Code Guidelines that need to be followed for positive reviews === | === Basic Code Guidelines that need to be followed for positive reviews === | ||
* All TABs shuld be replaced by 4 spaces - use the "use spaces" option in your editor to substitute | * All TABs shuld be replaced by 4 spaces - use the "use spaces" option in your editor to substitute Tab with spaces | ||
* No spaces should be present at the end of a line after ";", "}", "{" or any other line ender | * No spaces should be present at the end of a line after ";", "}", "{" or any other line ender | ||
* Comments should be added in the code to explain what the code does every time you consider that you would have to explain what or why you did things like that | * Comments should be added in the code to explain what the code does every time you consider that you would have to explain what or why you did things like that | ||
| Line 54: | Line 54: | ||
* When naming methods and variables use suggestive names and use camel case for them (the name starts with a non-capital letter, the words making up the name are not separated and each following word is capitalized): | * When naming methods and variables use suggestive names and use camel case for them (the name starts with a non-capital letter, the words making up the name are not separated and each following word is capitalized): | ||
e.g. thisIsAVariableNameWrittenInCamelCase | e.g. thisIsAVariableNameWrittenInCamelCase | ||
* If a method used in your test would be usefull in further/other tests define it in BaseTest or PixelTest not in your test class | * If a method used in your test would be usefull in further/other tests define it in BaseTest or PixelTest not in your test class - '''This is not a requirement for positive review but will usually result in a follow-up bug after patch acceptance''' | ||
* Make variables and methods which do not need to be accessed from outside '''private''' | * Make variables and methods which do not need to be accessed from outside '''private''' | ||
* Declare variables that do not change '''final''' | * Declare variables that do not change '''final''' | ||