Nomenclatura de CX

 

Como sabemos una nomenclatura nos ayuda a generar un estándar para el desarrollo de nuestras aplicaciones y para tener una integración mas simple, nosotros tampoco seremos la excepción  y nos acoplaremos al uso de un estándar.

 

El estándar que propongo a utilizar lo he desarrollado a lo largo de mi experiencia como desarrollador y utiliza a criterio mío las mejores prácticas de cada uno de los estándares que conozco.

 

Es importante mencionar que el idioma para la programación, no me refiero a los comentarios estos deben estar en español, lo que me refiero es al nombramiento de las cosas debe estar en ingles.

 

Primero empecemos con la forma de nombrar las cosas en la lista siguiente se pone un ejemplo de cada uno:

 

Tipo	Estándar
Namespace	Namespace
Clase	TestClass
Interfase	ITestInterface
Enumeración	ETestEnum
Miembro	this.testMember
Miembro estático	Class.__staticMember
Método	testMethod()
Método estático	Class.__staticMethod()
Variable	testVar
Parámetro	_testParam
Evento	TestEvent
Constante	CONST

 

Con la tabla anterior podemos nombrar todo dentro de nuestro código y es bastante sencillo para utilizar ya que en cualquier momento podemos saber que estamos usando con solo ver la forma en que esta escrito. (No utilizamos nomenclatura Húngara)

 

El nombre que les demos siempre hace referencia a la acción que desenvuelve como a continuación muestro algunos ejemplos:

 

namespace Entity

{

    public class User

    {

 

        /* Miembros de clase */

        private string name;

        private string male;

       

        /* Miembros de clase estaticos*/

        private static string __group;

        private static string __size;

 

        /* Constantes */

        private const int MIN_AGE = 15;

        private const int MAX_AGE = 99;

 

        /* Constructores */

        public User(string _name, string _male)

        {

            this.name = _name; // <-- Uso de parametros

            this.male = _male;

        }

 

        /* Metodos de clase*/

        public string getMale()

        {

            return this.male; // <-- Uso del this

        }

 

        /* Metodo estaticos de clase */

        public static string __getGroup()

        {

            return User.__group; // <-- Uso de la clase

        }

 

    }

}

 

En el ejemplo anterior podemos ver la forma de definir los nombres así como un ejemplo de cómo se usan. Con este pequeño ejemplo podemos saber en todo momento a que estamos haciendo referencia dentro del código únicamente con ver la sintaxis.

 

Nota. Los miembros de clase siempre deben ser privados o protegidos y la forma de acceso es mediante propiedades o funciones.

 

También es importante ver el orden en que se deben encontrar ubicado nuestro código. Aquí muestro un mapa del orden en que debe estar el código:

 

namespace Entity

{

    public class User

    {

        /* Constantes */

       

        /* Miembros estaticos */

 

        /* Miembros */

 

        /* Eventos */

 

        /* Constructores */

 

        /* Metodos Estaticos */

 

        /* Metodos */

    }

}

 

Es importante también ordenar la forma en que se declaran en cada una de las secciones y siempre siguiendo este patrón:

 

namespace Entity

{

    public class User

    {

        /* Inicia Seccion */

       

        /* Default */

 

        /* Publico */

 

        /* Protegido */

 

        /* Privado */

 

        /* Termina Seccion */

    }

}