estandares de codigo (emanuel)

Estándares y Buenas Practicas

Introducción

Un Estándar de programación es:

Una forma de "normalizar" la programación de forma tal que al trabajar en un proyecto, cualquier persona involucrada en el mismo tenga acceso y comprenda el código.

Y nos permite:

Definir la escritura y organización del código fuente de un programa.

Facilita a un programador la modificación de tu propio código fuente aunque no estés trabajando en el equipo.

Definir la forma en que deben ser declaradas las variables, las clases, los comentarios.

Especificar que datos deben incluirse acerca del programador y de los cambios realizados al código fuente, etc.

Por buenas prácticas se entiende a un conjunto de acciones que han rendido buen o incluso excelente servicio en un determinado contexto y que se espera que, en contextos similares, rindan similares resultados.

Algunos Ejemplos

Notación Pascal – El primer carácter de todas las palabras se escribe en Mayúsculas y los otros caracteres en minúsculas.

Ejemplo: ColorDeFondo

Notación de Camell – El primer carácter de todas las palabras, excepto de la primera palabra se escribe en Mayúsculas y los otros caracteres en minúsculas.

Ejemplo: colorDeFondo

Usa palabras entendibles y descriptivas para nombrar a las variables. No usar abreviaciones.

Correcto:

string direccion;

int salario;

Incorrecto:

Incorrecto

string nom;

string domic;

int sal;

Las llaves ({}) deben estar en el mismo nivel que el código fuera de las llaves.

if ( … )

{

//Haz algo

// …

return false;

}

Un método debe tener solo ‘una tarea’. No combines más de una tarea en un solo método, aún si esas tareas son pequeñas.

Correcto:

//Guarda la dirección

//Envia un email para informar que la dirección es actualizada.

SetDirección ( direccion );

EnviaCorreoAlSupervisor( direccion, email );

void SetDirección ( string direccion )

{

// Guarda la dirección.

// …

}

void EnviaCorreoAlSupervisor ( string dirección, string email )

{

// Envia un correo para informar que la dirección fue cambiada.

// …

}

Incorrecto:

// Guarda la dirección y envía un correo al supervisor para informar que

// la dirección fue cambiada.

GuardaDireccion ( direccion, email );

void GuardaDireccion ( string direccion, string email )

{

// Tarea 1.

// Guarda la direccion.

// …

// Tare1a 2.

// Envia un correo para informar al supervisor que la direccion fue cambiada

// …

}

• Arduino es una plataforma de electrónica abierta para la creación de prototipos basada en software y hardware flexibles y fáciles de usar.

• Se creó para artistas, diseñadores, aficionados y cualquiera interesado en crear entornos u objetos interactivos.

• Arduino puede tomar información del entorno a través de sus pines de entrada de toda una gama de sensores y puede afectar aquello que le rodea controlando luces, motores y otros actuadores.

• El micro controlador en la placa Arduino se programa mediante el lenguaje de programación Arduino (basado en Wiring) y el entorno de desarrollo Arduino (basado en Processing).

• Arduino recibió una Mención Honorífica en la sección Digital Communities de la edición del 2006 del ArsElectronica Prix.