Buenas Prácticasde Programación

Introducción

• Recordar realizar una codificación clara y concisa, utilizando toda la potencia que proporciona el lenguaje.

• No utilizar campos públicos: deben ser siempre privados a una clase y si se deben exponer se deben mostrar a través de una propiedad.

• Utilizar los elementos del lenguaje según su propósito. Por ejemplo, no utilizar una propiedad para realizar una operatoria compleja ya que no se creó para tal fin: se debe usar un método.

• Ante la duda, dirigirse a la documentación (Guías de buenas prácticas o la propia ayuda del .NET)

Capitalización

Hay cuatro maneras de manejar las mayúsculas en las palabras de los elementos del lenguaje:

• Camel: se escribe la primera letra en minúscula, y las siguientes componentes del nombre en mayúsculas. Ej: cuentaCorriente, cajaAhorro, personaFisica.

• Pascal: se escriben las letras iniciales componentes del nombre enmayúsculas. Ej: PersonaJuridica, ImpresoraLaser.

• Húngara: se coloca un prefijo indicando el tipo y luego el nombre del elemento, con mayúscula en las palabras constitutivas del nombre del elemento. Ej: strPalabra (string), intCantidadRecibidos (entero).

• Mayúsculas: toda la palabra se escribe con letras mayúsculas: se usa mucho para abreviaturas y acrónimos bien conocidos. Ej: System.Web.UI, System.IO.

La notación Húngara no la utilizamos.

Capitalización: Reglas Generales Portal Autogestión Individuos

• No crear espacios de nombre, clases, propiedades, funciones, que se diferencien únicamente por las mayúsculas y/o minúsculas de los nombres.

• El IDE corrige automáticamente estas cuestiones, pero otros editores no.

Abreviaturas: Reglas Generales

• En lo posible evitar las abreviaturas: éstas únicamente deben ser usadas en casos que éstas sean muy conocidas (Ej: Html, UI, IO).

• No usar acrónimos que no sean aceptados en el campo de la informática.

• Para acrónimos utilizar capitalización Pascal cuando hay más de 2 caracteres. Ej: Html, Wsdl.

Nomenclatura de espacios de nombres

• Se utiliza capitalización Pascal.

• Debe evitarse utilizar nombres de espacios provistos por .NET Framework.

• La constitución recomendada de un espacio de nombres es CompanyName.TechnologyName[.Feature][.Design]

Nomenclatura de Clases

• Las clases se nombran con un sustantivo.

• Se usa capitalización Pascal.

• Utilice las abreviaturas con moderación.

• Evitar las preposiciones. En vez de escribir EstadoDeCuenta, escribir EstadoCuenta.

• No utilizar el carácter “_”Ejemplos correctos:

Public Class FileStreamPublic Class ButtonPublic Class String

Nomenclatura de Enumeraciones

• Se utiliza capitalización Pascal para los nombres de las enumeraciones y de sus valores.

• NO UTILIZAR el sufijo Enum.

• Se utiliza un sustantivo para el nombre del tipo y de los valores de la enumeración.

Nomenclatura de Parámetros

• Se debe utilizar un sustantivo que represente el valor que trae el parámetro.

• El nombre debe ser autodescriptivo: no debería hacer falta una descripción del parámetro para saber qué debe contener o el tipo del mismo.

• Se utiliza capitalización camel para los parámetros.

• La práctica habitual indica que se le agrega una letra p delante del nombre. Ej: pPais, pNumeroCtaCte.

Nomenclatura de Métodos

• Se deben utilizar verbos o frases verbales como nombres.

• Se utiliza capitalización Pascal.

• El nombre debe ser autodescriptivo de la función del método.

• Utilizar abreviaturas con moderación.

• No utilizar “_” en el nombre.

Nomenclatura de Propiedades

• Se debe utilizar un sustantivo como nombre.

• Se usa capitalización Pascal.

• Debe ser un nombre que describa lo que el parámetro contiene más que el tipo del mismo.

A tener en cuenta…

• Recordar realizar una codificación clara y concisa, utilizando toda la potencia que proporciona el lenguaje.

• No utilizar campos públicos: deben ser siempre privados a una clase y si se deben exponer se deben mostrar a través de una propiedad.

• Utilizar los elementos del lenguaje según su propósito. Por ejemplo, no utilizar una propiedad para realizar una operatoria compleja ya que no se creó para tal fin: se debe usar un método.

• Ante la duda, dirigirse a la documentación (Guías de buenas prácticas o la propia ayuda del .NET)