» 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

~10h ago

microdee: There was a problem with DX11’s VPM pack, now I switched everything depending on DX11 to the contrib zip file. It should work now.

~15h ago

unti: Please remove Hauppauge from the list of supported videoIn cards. They still don't seem to work with vvvv.

~2d ago

Lorenz: What if screens could be shaped into any form? screenization-experiment-materiality

~4d ago

joreg: @bo27 one cross each!

~4d ago

bo27: @joreg should I answer again? :))

~5d ago

joreg: ~200 answers to the survvvvey so far. Can we double this? Please remind your friends/collegues to fill out: https://t.co/gHvameecfn #vvvv

~5d ago

gegenlicht: The "im not a robot" login dialog just gave me a minor existential crisis.

~7d ago

tonfilm: @schlonzo dark theme is not released yet, you have to wait a bit for the vvvv gamma release...

~7d ago

schlonzo: how do I switch VL into black mode?

~8d ago

evvvvil: Yo I'm live on TWITCH doing some live coding. 25 minutes time limit, "shader showdown" demoscene battle style. https://www.twitch.tv/evvvvil_