Convenciones del uso de Mayúsculas y minúsculas

Muchas convenciones de nomenclatura hacen uso de las mayúsculas y minúsculas en sus identificadores.

Entre ellas tenemos:

1. Estilo Pascal (PascalCase)
La primera letra del identificador y la primera letra de las siguientes palabras concatenadas están en mayúsculas. El estilo de mayúsculas y minúsculas Pascal se puede utilizar en identificadores de tres o más caracteres, por ejemplo:
ImageSprite

2. Estilo camelCase
La primera letra del identificador está en minúscula y la primera letra de las siguientes palabras concatenadas en mayúscula, por ejemplo:
imageSprite

3. Estilo Mayúsculas (ALL_CAPS)
Todas las letras del identificador se encuentran en mayúsculas ejemplo
IO

4. Estilo minúsculas (small_caps)
Todas las letras del identificador se encuentran en minúsculas ejemplo
system

Esta designación de la convención se utiliza muy poco

Cada lenguaje de programación hace uso de estos estilos según el identificador que use y de acuerdo a su convención.

En la siguiente tabla tenemos, las convenciones usadas por cada lenguaje de progragramción

Convención de Nombres

La convención de nombres es un conjunto de normas y reglas para la escritura de nombres, código fuente, identificadores y comentarios dentro de la programación, que facilitan y hacen más comprensible su lectura.

1. Clases

• Las clases representan “cosas” y no “acciones”, por tal motivo evitar verbos como nombre de clase.
• El nombre de la clase debe estar en singular, salvo que la clase represente multiplicidad de cosas.
• Las Nombres de las clases deberían ser Sustantivos: ejemplo carro, hombre, tienda, pais, empleado, proveedor
• Cada clase debe tener un bloque de documentación según la norma del lenguaje.

[PHP]
/**
* Bloque de Documentación
*/
class SampleClass
{
//contenido de la clase
}

[/PHP]

///
/// Bloque de Documentación
///
public class SampleClass
{
//contenido de clase
}

/**
*  Bloque de Documentación
*/
public class SampleClass
{
//contenido de la clase
}

2. Métodos

• Los nombres de los métodos deberían ser un verbo, dado que describe una acción ; ejemplo remover(), enviar(), cargar()
• Los Métodos dentro de las clases siempre debe declarar su visibilidad tales como privadas, protegidas, públicas, etc

3. Variables

• Evitar variables que sean de un solo carácter, Los nombres comunes para las variables temporales son i, j, k, m, y n para los números enteros; c, d, y e para los caracteres.
• Nombres de variables sólo pueden contener caracteres alfanuméricos
• Nombres de variables deben ser camelCase

4. Constantes
Según el tipo de lenguaje tenemos algunos ejemplos

4. Comentarios
Según el tipo de lenguaje que estemos usando podemos guiarnos de sus reglas y convenciones establecidas:
- php phpDocumentator
- c# MDSN guia
- java javadoc

Conclusiones
Hay muchas cosas mas que se quedan en el tintero, pero creo que con esta miniguía podemos empezar hacer que nuestro código sea mas elegante, profesional, fácil de entender y que nuestras aplicaciones puedan ser mas rápidos de mantener

Links Relacionados
http://java.sun.com/docs/codeconv/html/CodeConventions.doc10.html#182
http://framework.zend.com/manual/en/coding-standard.coding-style.html
http://msdn.microsoft.com/en-us/library/ms229043.aspx
http://www.irritatedvowel.com/Programming/Standards.aspx

“En el apuro por cumplir un plazo de desarrollo de aplicaciones, es fácil descuidar el estilo y la legibilidad.” Nigel Cheshire

¿Por que deberíamos de apegarnos a estas reglas?

Por lo siguientes motivos:

• Hacer mas legible el código
• El 80% del coste de la vida útil de una pieza de software se destina al mantenimiento
• Casi ningún software se mantendrá durante toda su vida, por el autor original
• Dentro de un equipo de programadores es mas fácil entender el código y a la vez mas fácil depurarlo
• Hacer que el código sea mas fácil de reutilizarlo
• Reducir los números de errores lógicos en el código y el tiempo en su depuración.

“Cuando usted se siente obligado a añadir un comentario, considere la posibilidad de volver a escribir el código para hacerlo más claro.” SUN Microsystems

Muchas veces no reparamos en las consecuencias que pueda tener a largo plazo, el no seguir estas normas, pasándolas por alto o dejándolos para otro momento.

Veamos el siguiente cuadro

Como vemos las consecuencias pueden ser desagradables, ya que incrementarán el tiempo y el costo de mantenimiento, hasta llegar al punto que va ser mucho más sencillo volverlo a desarrollar todo desde cero.

Empecemos!

Estilo de programación

Hace referencia a como formateamos el código que estamos desarrollando, tales como llaves, indentación, paréntesis, el espaciado, etc. Esto puede diferir entre lenguajes de programación.

A continuación les dejo una pequeña guía personal basándome en los estilos de Java, C# y PHP

1. Indentación
Sobre como indentar hay varios estilos tales como: Allman, K&R, BSD KN, Whitesmiths, etc.
Considero que el estilo Allman es el mejor, el cual dice que debemos usar los sangrados para indentar el código, nunca espacios. Poner las llaves de control en la línea subsiguiente.

2. Saltos de Línea

• Añadir un salto de línea después del cierres de los paréntesis de los parámetros.
• Añadir un salto de línea después un punto y coma, cuando termina la sentencia.

3. Espacios y líneas en blanco

• Usar espacios en blanco para mejorar la legibilidad del código.
• Usar espacios en blanco e ambos lados del operador de símbolos, después de comas y después de las declaraciones.
• Usar líneas en blanco para separar trozos de código.
• Usar líneas en blanco antes de cada método dentro de la clase.

4. Longitud de la línea
Evite las líneas de mas de 80 caracteres cuando supera se debe córtalo bajo los siguiente principios

• Salto de línea después de la coma.
• Salto de línea después de un operador.
• Alinear la nueva línea con el principio de la expresión en el mismo nivel en la línea anterior.

Hasta aquí llegamos hoy, en la próxima veremos sobre la convención de nombres