Convención de nombre sobre componentes Java Swing (prefijo)

Question

Una pregunta que tuve en mente cuando programé con Swing en Java fue, ¿es una recomendación o una convención de nomenclatura "oficial"/más utilizada en componentes Swing?

tales como (a pesar de que otros pueden preferir otras convenciones de nomenclatura esto es lo que estoy utilizando actualmente):

• txt para JTextField
• btn para JButton
• LBL para JLabel
• PNL para JPanel

Pero entonces mi lista termina ..

Creo que tales prefijos mejoran la legibilidad en mi código, pero no tengo nombres para componentes como JComboBox, JList, JRadioButton, JCheckButton y la lista continúa.

Gracias de antemano.

Answer 1

La gente le dirá que usar prefijos es malo, porque esa es la notación húngara y, actualmente, la notación húngara se considera un gran no-no en la programación. Personalmente, como alguien que ha hecho una cierta cantidad de trabajo en GUI, puedo decir que, mientras que la notación húngara definitivamente debe evitarse en la programación sin GUI, al hacer GUI es una muy buena práctica.

Considere, por ejemplo, un formulario simple con un cuadro de texto que se utilizará para ingresar el nombre del usuario. Delante de este cuadro de texto debe haber una etiqueta que le pide al usuario que ingrese su nombre en el cuadro de texto. Ahora, ¿cómo vas a nombrar el cuadro de texto? 'Nombre'? ¿Qué pasa con la etiqueta? Una buena práctica debe ser el prefijo del cuadro de texto con txt y la etiqueta con la etiqueta, que es de lo que se trata la notación húngara. Por lo tanto, el cuadro de texto ahora se llama 'txtName' y la etiqueta correspondiente se llama 'lblName'.Esto le brinda la ventaja adicional de acceder fácilmente a sus cuadros de texto, cuadros combinados y otros widgets cuando está en el editor de su IDE. Por ejemplo, al escribir 'txt' y presionar CTRL + Espacio en Eclipse, se abre un menú contextual que enumera todos sus cuadros de texto, si sigue esta notación.

Ahora, para responder a su pregunta. La forma habitual de definir qué tres letras debe usar para un prefijo es eliminar todas las vocales del nombre del widget y también todas las consonantes que se repiten. Si quedan más de tres consonantes, deben ignorarse. Por lo tanto, un cuadro de texto (o TextField, o lo que sea que se llame este widget en su kit de herramientas preferido) se convierte en 'txt', una etiqueta 'lbl', un cuadro combinado 'cmb', una tabla 'tbl', etc.

Answer 2

Normalmente odio este tipo de cosas, porque huele a notación húngara. No me gusta la idea de incrustar el tipo en el nombre de la variable, porque si cambia los tipos, no debería exigir el cambio de todos los nombres de las variables.

Pero en el caso de Swing, supongo que es aceptable.

Un buen IDE generará nombres de variables para usted. ¿Por qué no lo dejas? También me gustaría deletrear el tipo si insiste (por ejemplo, submitButton en lugar de btnSubmit). Las pulsaciones de teclas son baratas.

Answer 3

¿Por qué no llamar JTextField textField, JButton button, JLabel label y JPanel panel. ¿Es tan malo gastar algunos caracteres adicionales para hacer que la variable se lea como una palabra en inglés?

Además, cuando pongo el tipo en el nombre de la variable, lo pongo al final. Entonces, un JLabel que muestra un nombre es nameLabel (que IMO es más legible que lblName).

Y aún más, siguiendo el consejo de duffymo, es una mala práctica poner el tipo en el nombre de la variable. Un mejor enfoque es describir lo que es la variable. En el caso de una etiqueta de nombre, es un componente de interfaz de usuario que muestra el nombre. Entonces, un nombre mejor podría ser nameComponent. El hecho de que nameComponent sea un JLabel o algún otro tipo es secundario y no debe saturar el nombre de la variable.