Code Style Guidelines

Style Guidelines

It truly does not matter what coding style you have in a given project. It is not as if myVariable is better than my_variable. What is important is being consistent. If the code is consistently-styled, then this acts as a rudimentary in-text documentation for the coding team. This document exists to explain the current coding style in Brewtarget so that we and the codebase remain consistently-coded.

##Tabs

Please do not use tabs. Instead, configure your editor to use 3 spaces instead of tabs.

If using vim, the following lines in ~/.vimrc are sufficient

set expandtab
set tabstop=3
set shiftwidth=3

##Naming

###Variables

lowerCamelCase

###Functions

lowerCamelCase()

###Classes

UpperCamelCase