StyleGuide.md

Verto Studio Code Style Guide

To keep things consistent, all pull-requests to the Verto Studio Code base (including the VGL Vulkan Core) should adhere to these following C++ code style guidelines. Sorry to be a stickler, but this codebase is where I spent a lot of my time, so I prefer it to be styled a certain way consistent to the rest of the engine :).

Indent

Please use 2-space indents (no tabs)

Braces, Newlines, Parens & Blocks

Please use next-line braces when declaring functions and code blocks. Do not place any extraneous newlines between braces and code (one line to separate line groups is fine). Do not place any spaces between function calls and parameter list parentheses. Do not place any spaces between if/for/while/etc and parentheses. Do place spaces after commas in parameter lists.

void func()
{
  int hello = 0;

  if(externVariable)
  {
    methodCall1();
    methodCall2(hello, 0, 1, 2);
  }
  else
  {
    cmone();
  }

  for(int i = 0; i < 150; i++)
  {
    things(i);
  }
}

When writing lambdas, you can use the brace on the same line. This is one of the only places where same-line braces should be used.

auto myLambda = [] {
  return 50;
};

In the case of one-liner if-statements, no braces are acceptable, but not required. Use spaces between logical operators.

if(lazyIfStatement && lazyIfStatement2)
  lazyFunctionCall();

Method & Variable Case

Use camelCase for all variable names and method names. Use UpperCase for any and all Type names (classes, structs, etc).

class SomeClass
{
public:
  static const int Constant = 0;

  void someMethod();
  void anotherTypeOfMethod();

  inline int oneLinerInlinesAreOkay() { return var; }

protected:
  int var = 0;
};

Constants

I've been somewhat inconsistent with my constants depending upon where they are unfortunately. #-defined constants are always in caps as shown below. Just be consistent within a file.

class SomeClass
{
public:
  static const int ClassConstant;   //okay
  static const int CLASS_CONSTANT;  //also okay, but be consistent within a given file. 
};

static const int globalFileLocalConstant = 0;  //camel-case sometimes used in file/block scopes

#define DEFINED_CONSTANT_OR_MACRO       0   //preprocessor stuff always all-caps

Enums

Enums are type-names, so their name is capitalized. All enum values are abbreviations of their type, followed by the value itself. i.e.

enum InsaneTextureType
{
  ITT_2D,
  ITT_3D,
  ITT_4D,
  ITT_5D
};

enum BananaShake
{
  BS_PLAIN,
  BS_CHOCOLATE,
  BS_PROTEIN_VANILLA
};

Pointers & References

Keep the * next to the variable name, not the type.

void *ptr = nullptr;
const auto &ref = someVar;

void method(char *str, void *ptr, ostream &ostr);

Initializer Lists

Any of the following are acceptable, but be consistent within a method/block.

int arr[] = { 0, 1, 2, 3 }; //ok

vector<int> arr =           //ok
{
  0, 1, 2, 3, 4, 5,
  6, 7, 8, 9, 10, 11
};

int arr[] = {               //fine in the case of initializer lists
  0, 1, 2, 3, 4
};

Literals

Floating point literals should be of the form 0.5f and not .5f. For null pointers, use nullptr. Do not use NULL unless you are calling standard C APIs.