Convención de denominaciones de Java

Facilite su vida

Como primer consejo, Scott Ambler presenta algunas pautas para denominar varios elementos de Java para hacer su trabajo más fácil.

Scott W. Ambler, Practice Leader, Agile Development, Rational Methods Group, IBM, IBM

Scott W. Ambler es el presidente de Ronin International, una firma consultora que se especializa en el proceso de consejería de software orientado a objetos, modelo arquitectónico y desarrollo de Enterprise JavaBeans (EJB). Es autor y coautor de varios libros acerca del desarrollo orientado a objetos, incluido el recientemente publicado The Object Primer, 2.ª edición, el cual aborda en detalle los temas resumidos en este artículo. Se lo puede contactar en scott.ambler@ronin-intl.com y en su website www.ambysoft.com.



10-12-2012

Utilice descriptores completos que describan la variable, el campo o la clase de manera adecuada

Desarrolle habilidades de este tema

Este contenido es parte de un knowledge path progresivo para avanzar en sus habilidades. Vea Conviértase en un desarrollador Java

Por ejemplo, nombres de usuario como firstName, grandTotal o CorporateCustomer. Aunque nombres como x1, y1 o fn son fáciles de tipear porque son cortos, no brindan ninguna indicación de lo que representan y consecuentemente resultan en un código difícil de entender, mantener y mejorar.


Utilice terminología aplicable al dominio

Si sus usuarios se refieren a sus clientes como consumidores, utilice el término Customer para la clase, no Client. Muchos desarrolladores cometen el error de crear términos genéricos para conceptos cuando ya existen términos perfectamente utilizables en la industria o dominio.


Utilice mayúsculas y minúsculas para que los nombres sean legibles

Debería utilizar letras minúsculas en general, pero utilice mayúscula en la primera letra de nombres de clase y de interfaz, así como la primera letra de cualquier palabra no inicial.


Utilice abreviaturas con moderación e inteligencia

Esto significa que debería mantener una lista estándar de formas cortas (abreviaturas), elegirlas sabiamente y utilizarlas de manera consistente. Por ejemplo, si desea utilizar una forma corta para la palabra number, utilice nbr, no o num, registre el utilizado (no importa cuál) y utilice únicamente ese.


Evite nombres largos (15 caracteres como máximo es una buena idea)

Aunque el nombre de clase PhysicalOrVirtualProductOrService puede parecer un buen nombre en el momento (de acuerdo, los estoy alargando en este ejemplo), este nombre es simplemente demasiado largo y debería considerar cambiarle el nombre a algo más corto (quizás algo como Offering).


Evite nombres que son demasiado parecidos o que difieren sólo en mayúscula o minúscula

Los nombres de variables persistentObject y persistentObjects no deberían ser utilizados juntos, ni tampoco anSqlDatabase y anSQLDatabase.


Utilice mayúscula en la primera letra de acrónimos estándar

Los nombres tendrán por lo general abreviaturas estándar, como SQL por Standard Query Language. Nombres como sqlDatabase para un atributo o SqlDatabase para una clase son más fáciles de leer que sQLDatabase y SQLDatabase.

Recursos

Comentarios

developerWorks: Ingrese

Los campos obligatorios están marcados con un asterisco (*).


¿Necesita un IBM ID?
¿Olvidó su IBM ID?


¿Olvidó su Password?
Cambie su Password

Al hacer clic en Enviar, usted está de acuerdo con los términos y condiciones de developerWorks.

 


La primera vez que inicie sesión en developerWorks, se creará un perfil para usted. La información en su propio perfil (nombre, país/región y nombre de la empresa) se muestra al público y acompañará a cualquier contenido que publique, a menos que opte por la opción de ocultar el nombre de su empresa. Puede actualizar su cuenta de IBM en cualquier momento.

Toda la información enviada es segura.

Elija su nombre para mostrar



La primera vez que inicia sesión en developerWorks se crea un perfil para usted, teniendo que elegir un nombre para mostrar en el mismo. Este nombre acompañará el contenido que usted publique en developerWorks.

Por favor elija un nombre de 3 - 31 caracteres. Su nombre de usuario debe ser único en la comunidad developerWorks y debe ser distinto a su dirección de email por motivos de privacidad.

Los campos obligatorios están marcados con un asterisco (*).

(Por favor elija un nombre de 3 - 31 caracteres.)

Al hacer clic en Enviar, usted está de acuerdo con los términos y condiciones de developerWorks.

 


Toda la información enviada es segura.


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=90
Zone=SOA y servicios web
ArticleID=850777
ArticleTitle=Convención de denominaciones de Java
publish-date=12102012