Ir al contenido principal

Convenciones de nombres en POO



Es importante que antes de programar se definan acuerdos o convenios que sirvan para establecer buenas prácticas o estándares de codificación y documentación del código. 

A continuación se listan algunas convenciones de nombres a considerar y que se seguirán en los ejemplos de programación publicados en este blog:

  • Las clases se nombran en mayúscula la primera letra. Por Ejemplo: Trabajador.
  • Los atributos de una clase se nombran en minúscula la primera letra. Por Ejemplo: nombre.
  • Los métodos de una clase se nombran en minúscula la primera letra. Por Ejemplo: carcularSueldo().
  • Las constantes se nombran todo en mayúscula. Por Ejemplo: TIPO_TIEMPOCOMPLETO.
  • Las variables se nombran en minúscula la primera letra. Por Ejemplo: descuento.
  • Los objetos instanciados se nombran en minúscula la primera letra. Por Ejemplo: trabajador.
  • Los parámetros de los métodos se nombran en minúscula la primera letra. Por Ejemplo: nombre.
  • Los paquetes se nombran todo en minúscula. Por Ejemplo: sistemajava.
  • Los nombres de clases deben estar en función al objetivo que se busca de acuerdo a sus responsabilidades o al tipo de objeto que representa. Puede estar expresado como sujeto o una combinación de verbo en infinitivo y sujeto. Por Ejemplo: Trabajador, GestionarTrabajador.
  • Los nombres de métodos deben estar en función a la responsabilidad que debe resolver o colaborar. Se puede referir a un cálculo matemático, a una validación o verificación de alguna regla o condición, a un procedimiento, a una acción o comando. Se expresa como verbo en infinitivo o una combinación de verbo en infinitivo y sujeto. También puede nombrarse iniciando como es o está si el método retorna un valor verdadero o falso. Por Ejemplo: calcularSueldo(), estaActivo(), registrarTrabajador(), insertar().
  • Los nombres de atributos se escriben por lo general como una característica o propiedad de algún sujeto que representa algún dato o estado. Por Ejemplo: nombre, sueldo, tipo, activo.
  • Los nombres de objetos se escriben por lo general con el mismo nombre de su clase o tipo al que pertenece. Por Ejemplo: el objeto trabajador, es del tipo o clase Trabajador.
  • Los nombres de paquetes deben estar en función a una responsabilidad general que involucre a un conjunto de clases que buscan o cumplan fines o responsabilidades similares. Por Ejemplo: entidades. Este paquete puede incluir a clases como Trabajador, Contrato y Proyecto que son clases relacionadas cuya finalidad es representar las clases del dominio de problema donde se maneja la información.
  • Los nombres de clases, atributos, métodos, variables, constantes, objetos y paquetes deben ser claros y entendibles a la vista y no requerir una descripción o documentación adicional para entender su significado. Por Ejemplo: calcularSueldo(), es entendible fácilmente. Sería incorrecto nombrarlo como: calSueldo(), calSuel(), calcularS(), o c_s().
  • En caso se usen siglas para los nombres como un prefijo o sufijo, estos si deben quedar documentados en el código, manual o glosario de términos.

Comentarios

Entradas populares de este blog

Manejo de fechas en Java 8 con LocalDate

En el programa desarrollado y mostrado en esta oportunidad, se han usado tres clases de la biblioteca de Java 8: la clase  java.time.Period  que sirve para determinar rangos como el total de años entre dos fechas, la clase  java.time.format.DateTimeFormatter  que sirve para dar diversos formatos a la fecha, y principalmente la clase  java.time. LocalDate   que es un objeto de fecha y hora inmutable que representa una fecha, a menudo visto como año-mes-día, además permite realizar de forma simple diversas operaciones de fecha.

Calendario en Java con GregorianCalendar

En el programa desarrollado y mostrado en esta oportunidad, se han usado tres clases de la biblioteca de Java: la clase  java.util.Date  que sirve para crear una fecha actual del sistema, la clase  java.text.DateFormat  que sirve para dar formato a la fecha, y principalmente la clase  java.util. GregorianCalendar   que sirve para manipular fechas.

Formato de fechas en Java con SimpleDateFormat

En el programa desarrollado y mostrado en esta oportunidad, se han usado dos clases de la biblioteca de Java: la clase  java.util.Date  que sirve para crear una fecha actual del sistema, y la clase  java.text.SimpleDateFormat  que sirve para dar diversos formatos de impresión a la fecha.