» Conventions.CodingStyle
This site relies heavily on Javascript. You should enable it if you want the full experience. Learn more.

Conventions.CodingStyle

French | Italian | Spanish

For better readability and standardization of VVVV related code we should all conform to the coding styles below:

Casing

Definitions

Pascal Casing

 RedHotChilliPeppers

Camel Casing

 redHotChilliPeppers

Classes

  • Pascal Casing
//good
class RedHot
 
//bad
class TRedHot
class redhot

Interfaces

  • start with an I (for Interface) and then Pascal Casing
//good
interface IRedHot
 
//bad
interface RedHotInterface
interface Iredhot

Class Variables

  • start with an F (for Field) and then Pascal Casing
//good
int FChilliPepper
 
//bad
int ChilliPepper 
int FchilliPepper

Local Variables, Function Arguments

  • Camel Casing
//good
int redPepper;
void Foo(int barCode);
 
//bad
int Redpepper;
int RedPepper;
void Foo(int BarCode);

Global Variables

  • start with a G and then Pascal Casing
//good
int GChilliPepper;
 
//bad
int ChilliPepperGlobal;
int GchilliPepper;

Functions

  • Pascal Casing
//good
PlayMusic();
 
//bad
playMusic();

Events

  • start with On.. and then Pascal Casing
//good
OnExplode
 
//bad
Explode
Onexplode

Events Callbacks

  • are named like their corresponding Events
  • end with ..CB
//good
ExplodeCB()
 
//bad
ExplosionCB()
explodeCB()

Braces

  • braces are always in a new line
//good
if true then
{ 
 ...
};
 
//bad
if true then { ... };
if true then {
   ...
 };

Indenting

  • always use 4 spaces

Spacing

  • there is always a single space after a comma or a semicolon, never before
//good
MyFunction(a, b);
 
//bad
MyFunction( a , b );
  • single spaces surround operators (except unary operators like increment or logical not)
//good
a = b;                       
for (int i = 0; i < 10; ++i) 
 
//bad
a=b;                             
for (int i=0; i<10; ++i)

Other Coding Guidlines

Note that certain incompatibilities to the similar guides listed below (which differ among themselves aswell) are deliberate.

Mono Coding Guidlines

.Net Design Guidlines

Sharp Develop Coding Guidlines

anonymous user login

Shoutbox

~3h ago

young47: Will visit Köln and Düsseldorf this week. I'm an artist from Moscow, would be happy to meet someone! If you will be there, reply :)

~4h ago

microdee: vpm got a clean-up update. Download here: https://github.com/vvvvpm/vpm/releases/tag/1.3

~2d ago

joreg: @udo2013 please note that bass is only available with x86 builds!

~2d ago

aeckheim: Can't find the visual c++ runtime 2008. setup.exe link leads to nowhere. try to setup newest beta version

~3d ago

joreg: More #vvvv workshop dates for the coming months are announced: upcoming-full-day-vvvv-gamma-workshops-in-berlin

~4d ago

mburk: @synth can confirm crashes with instance noodles. studio drivers fixed it.

~6d ago

synth: @nissidis: So i am not crazy! Thanks for confirmation :) These are the things i do have problems with as well.

~6d ago

nissidis: @synth I do with Instance Noodles and FieldTrip (RTX 2080) I rolled back to Studio Drivers (instead of GameReady ones)

~6d ago

synth: Anyone having problems with latest Nvidia Drivers and vvvv?