Difference between revisions of "Coding Style"
Jump to navigation
Jump to search
* '''Class names''': Camelcase, starting with uppercase letter, e.g.: '''FurnaceManager''' | * '''Class names''': Camelcase, starting with uppercase letter, e.g.: '''FurnaceManager''' | ||
* '''Variable and method names''': Camelcase, starting with lowercase letter, e.g.: '''updateWorld()''', '''userCommands'''. | * '''Variable and method names''': Camelcase, starting with lowercase letter, e.g.: '''updateWorld()''', '''userCommands'''. | ||
| + | ** '''Pointer variables''': Use '''Foo* bar''' instead of '''Foo *bar''' | ||
** Using short names for loop variables is ok, e.g. '''i''', '''j'''. Otherwise use descriptive names and don't use abbreviations all over the place, to make the code more readable. | ** Using short names for loop variables is ok, e.g. '''i''', '''j'''. Otherwise use descriptive names and don't use abbreviations all over the place, to make the code more readable. | ||
* '''Inline methods''': Keep them short (max 10-15 lines at most). | * '''Inline methods''': Keep them short (max 10-15 lines at most). | ||
