English | French | Italian

Para lograr una mejor legibilidad y estandarización del código asociado a vvvv, es necesario adherirse a los lineamientos de estilo de código listados a continuación:

• Mayúsculas y minúsculas
• Definiciones
• Clases
• Interfaces
• Variables de Clase
• Variables Locales, Argumentos de Funciones
• Variables Globales
• Funciones
• Eventos
• Callbacks de Eventos
• Llaves
• Indentación
• Espaciado
• Guías de Código Adicionales

Mayúsculas y minúsculas

Definiciones

 RedHotChilliPeppers

 redHotChilliPeppers

Clases

• Pascal Casing

//correcto
class RedHot
 
//incorrecto
class TRedHot
class redhot

Interfaces

• iniciar con una I (por Interface) y continuar con Pascal Casing

//correcto
interface IRedHot
 
//incorrecto
interface RedHotInterface
interface Iredhot

Variables de Clase

• iniciar con una F (por Field) y continuar Pascal Casing

//correcto
int FChilliPepper
 
//incorrecto
int ChilliPepper 
int FchilliPepper

Variables Locales, Argumentos de Funciones

• Camel Casing

//correcto
int redPepper;
void Foo(int barCode);
 
//incorrecto
int Redpepper;
int RedPepper;
void Foo(int BarCode);

Variables Globales

• iniciar con una G y continuar con Pascal Casing

//correcto
int GChilliPepper;
 
//incorrecto
int ChilliPepperGlobal;
int GchilliPepper;

Funciones

• Pascal Casing

//correcto
PlayMusic();
 
//incorrecto
playMusic();

Eventos

• iniciar con On.. y continuar con Pascal Casing

//correcto
OnExplode
 
//incorrecto
Explode
Onexplode

Callbacks de Eventos

• llevan el nombre de sus Eventos correspondientes
• terminan con ..CB

//correcto
ExplodeCB()
 
//incorrecto
ExplosionCB()
explodeCB()

Llaves

• las llaves siempre en una línea nueva

//correcto
if true then
{ 
 ...
};
 
//incorrecto
if true then { ... };
if true then {
   ...
 };

Indentación

• utilizar siempre 4 espacios

Espaciado

• siempre hay un único espacio después de una coma o punto y coma, nunca antes

//correcto
MyFunction(a, b);
 
//incorrecto
MyFunction( a , b );

• espacios únicos rodean a los operadores (excepto operadores unarios como el incremento o el NOT lógico)

//correcto
a = b;                       
for (int i = 0; i < 10; ++i) 
 
//incorrecto
a=b;                             
for (int i=0; i<10; ++i)

Guías de Código Adicionales

Note que algunas incompatibilidades con las guías que se listan a continuación (las cuales difieren entre sí a su vez) son deliberadas.

Mono Coding Guidlines

.Net Design Guidlines

Sharp Develop Coding Guidlines