Pages

domingo, 26 de mayo de 2013

Tips: Para una programación más limpia


Primero que nada disculpen la ausencia durante los últimos meses en los que compromisos académicos han tenido muerto el blog, se quiso realizar un itinerario, lo cual realmente no fue la mejor idea debido a la poca disponibilidad de tiempo que se puede tener siendo estudiantes de la UNET.

Cambiando de tema, hoy vengo a dejarles algunos tips de programación que pueden ser muy útiles al momento de trabajar en grupo donde habrán 5, 8 o 10 personas intentando "descifrar" nuestro código, o simplemente hacerlo más entendible para nosotros mismos(a quien no le ha pasado que tras algunos meses, revisan un proyecto y casi no recuerdan el porqué de las cosas). 

Nomenclatura:

1. Salvo por necesidades especiales y objetivas (como por ejemplo, participación internacional) todos los nombres de las variables utilizadas, deberán estar en el idioma en común de sus desarrolladores.

2. Salvo en constantes o identificadores creados por un generador de código, no se utilizada el símbolo ( _ ) para los nombres de un identificador.

3. No se utiliza la abreviación cuando el único ahorro de letras es muy pequeña. Ejemplo: Hora = Hr (No tiene sentido) Hora de Emision = HrEmision (Correcto)

4. Se ha llegado al acuerdo que la longitud del nombre de una rutina (función) debe estar entre lso 7 a 15 caracteres.

5.  Salvo causas justificadas, no se recomienda el uso de proposiciones o conjugaciones en un nombre.

6. No se utilizara ni sufijos ni prefijos en un nombre cuyo único propósito sea indicar el indicador. Ejemplo: CEvento, EventoClass.

7. En todo momento se deben usar nombres que sean claros, concretos y libres de ambigüedad. Esto ayudara a hacer más entendible nuestro código. Ejemplo: fechaNacimiento vs fecha, estadoImpresora vs estado.

8. Dado que las clases representan cosas y no accines, cada clase tendrá como nombre, palabras con sentido gramatical, y nunca verbos.

9. El nombre de una clase debe estar en singular, salvo que una de sus instancias represente multiplicidad de cosas.

10. El nombre de la clase no contendrá detalles de implementación de la misma.

11. Un buen nombre para una rutina es aquel el cual describe todo lo que esta hace.

12- Es recomendable que los métodos que no devuelven valores, tenga nombres que consistan en un verbo, seguido del objeto que lo afecta como; ImprimirFacturaCompra o CalcularVAN.

13. Para aquellas que si devuelven valores, es recomendable que describa el valor devuelto tal como: ImpresoraLista o VAN.

14. En ningún caso se debe utilizar verbos genéricos tales como: Procesar, Manejar, Gestionar, etc, sin especificar su utilidad, como: ProcesarInmueble, LeerDato...

15. Cuando existan grupo de funciones que realicen operaciones similares con pequeñas diferencias, se se deberá establecer un sistema de creación de nombres coherentes.

16. No se de deben crear rutinas mayores a 200 lineas. 

17. (Una que poco aplicamos) Se debe evitar el uso de variables i,j,k dentro de ciclos o rutinas, en mes de esto se deberian usar cosas como: indAlumnos, indCarros.

18. No se deben usar variables con nombre sin sentido, por ejemplo: variable1, variable2, variable3.

19. Las variables booleanas, deben tener nombres que indiquen su respuesta o contenido, como:  Éxito,, Correcto, etc.
  
20. Procura utilizar variables, en parte numéricas del código que puedan representar alguna acción o que se pueda repetir en diferentes partes del código. Esto te ayudara, tanto a un mejor entendimiento del código  como para cambiar un valor rápidamente en un momento dado.


0 Comentarios:

Publicar un comentario