Buenas prácticas de programación

Convenios para capitalización

03/06/2020

Gracias a las buenas prácticas sobre convenios de capitalización se podrá mejorar el entendimiento del código y de la nomenclatura. Como todas las convenciones, no son obligatorias puesto que el compilador no las impone necesariamente para el correcto funcionamiento, pero garantizará la claridad del código entre los desarrolladores.


1. Nomenclaturas:
Existen 3 tipos de nomenclaturas distintas:

  • Pascal Case: La primera letra de cada palabra concatenada de un nombre se escribe en mayúscula, el resto de caracteres en minúsculas.
    P.e: IniciarTransaccionSegura
  • Camel Case: La primera letra de toda la palabra se indica en minúscula y la letra de cada primera palabra concatenada se escribe en mayúscula, el resto de caracteres en minúsculas.
    P.e: codigoFormaPago
  • Upper Case: Todas las letras de todas las palabras se escriben en mayúsculas.
    P.e: CODIGOERROR

Cada nomenclatura se debe de utilizar en función de unas reglas que veremos a continuación.

2. Reglas:

3. Ejemplos:

  • Usa notación Pascal para nombrar las Clases.
    
    public class ClaseBase 
    { 
    …. 
    } 
    
  • Usa notación Pascal para nombrar los Constructores.
    
    public class ClaseBase 
    {
    	public ClaseBase()
    	{
    		…..
    	}
    }
    
  • Usa notación Pascal para nombrar los Métodos.
    
    void IniciarTransaccion (string código)
    {
    		….
    }
    
  • Usa notación Pascal para nombrar los Eventos.
    
    protected void ObtenerTarjetasIdUsuarioClick(object sender, EventArgs e)
    {
         	….
    }
    
    
    
  • Usa notación Pascal para nombrar los Namespace.
    
    namespace Indicus.Datos
    {
         	….
    }
    
    
    
    
  • Usa notación Pascal para nombrar los Tipos De Enumerador.
    
    enum DiasSemana
    {
         	….
    }
    
    
  • Usa notación Pascal para nombrar los Valores De Enumerador.
    
    enum Dias
    {
             Lunes,
             Martes,
             Miércoles,
             Jueves,
             Viernes,
             Sábado,
            Domingo	
    }
    
    
    
  • Usa notación Pascal para nombrar los Clases De Excepciones.
    
    public class LecturaCodigoBarrasException : System.Exception
    {
         	….
    }
    
    
    
    
  • Usa notación Pascal para nombrar los Intarfaces.
    
    interface ICoche
    {
         	….
    }
    
    
  • Usa notación Pascal para nombrar los Delegados.
    
    public delegate void LecturaCodigoDeBarrasEventHandler(object sender, LecturaCodigoDeBarrasEventArgs e);
    {
         	….
    }
    
    
  • Usa notación Pascal (correcta) o Upper (permitida) para nombrar las Constantes.
    
    //Correcto
    public const int CodigoErrorGenerico = 1;
    //Permitido (Separando las palabras con guiones bajos para que sea más legible)                
    public const int CODIGO_ERROR_GENERICO = 1;
    
    
  • Usa notación Camel para nombrar los Campos Estáticos De Solo Lectura.
    
    public static readonly int edadMaxima = 85;
    
  • Usa notación Camel para nombrar las Variables Locales.
    
    string nombreAbuelo = “Manuel”;
    
  • Usa notación Camel para nombrar los Parámetros
    
    void CompletarTransaccion (string codigoTransaccion, int numeroTransaccion, DateTime fechaFinalizada)
    {
    		….
    }
    
    
Felipe Arcos, es desarrollador full stack web y app .NET en Indicus Software y rock star con club de fans.

¿Te ha gustado el artículo? ¡Compártelo!