Documente Academic
Documente Profesional
Documente Cultură
Android
Hola,
Te ha pasado que algunas veces no sabes cmo nombrar tus archivos java, tus layouts, iconos, etc.?
O que no sabes cmo escribir tus clases, campos y mtodos Java?
A todos nos ha pasado alguna vez.
Es algo complicado porque cuando vuelves a releer tu cdigo para el mantenimiento de una app,
tendrs preguntas como:
- Y yo por que puse esto aqu?
- Chanfle! Qu es lo que hace este cdigo?
- Por qu fue que le puse as a esta variable?
Aunque parece algo insignificante, el nombrado dentro de nuestros proyectos Android juega un papel
importante para mantener consistencia en todo nuestro desarrollo.
Asocia nuestra forma de pensar y los conceptos que estamos asociando al problema tratado.
As que en este conjuntos de lineamientos que he preparado para todos los seguidores de Hermosa
Programacin, veremos algunas recomendaciones para mantener un orden.
Te soy sincero, ninguna es inventada por m.
Son varios recursos recopilados de otros autores (incluyendo a Google) que me han gustado y me han
ayudado a mejorar la legibilidad de mi cdigo.
No es que sea obligatorias ests notaciones, t y tu equipo pueden inventar las suyas.
Pero si por el momento no has pensado en ello, quizs este sea un buen comienzo.
Te parece :) ?
Si es as, entonces mira:
Convenciones Para Nombrar Archivos
Iniciando quiero comentarte una opinin personal:
Me parece ms sencillo el nombrado con el idioma Ingles.
Por qu?
Es ms compacto y la complicacin de las tildes no tiene cabida.
Es solo mi punto de vista, no es requisito para aplicar las guas que veremos.
Teniendo esto en mente, sigamos
Clases Java
Recuerda que el mismo nombre de las clases Java debe ser el mismo de su archivo.
Para nombrarla usa la notacin UpperCamelCase. Donde cada palabra debe llevar su primera letra en
mayscula.
Ejemplo:
LoginPresenter.java, SalesmenActivity.java, OrderItem.java.
Layouts
Mueve el nombre del componente al inicio y luego pon su objetivo.
[nombre_componente]_[objetivo]
Values
Normalmente los recursos con valores elementales deben escribirse en plural asociando su
naturaleza:
Strings values/strings.xml
Estilos values/styles.xml
Colores values/colors.xml
Dimensiones values/dimens.xml
Enteros values/integers.xml
Booleanos values/bools.xml
Iconos
Por el lado de los iconos, dependiendo del lugar a donde pertenezcan, as mismo los clasificamos con
prefijos.
Cdigo Java
Sobre este tema hay varias fuentes. Basta que pongas en Google java naming conventions y vers la
cantidad de estilos.
No obstante, la siguiente tabla resume el estilo ms usado para cada elemento de cdigo:
Bien Mal
XmlHttpRequest XMLHTTPRequest
getCustomerId getCustomerID
long id long ID
Cdigo XML
Nombres de los IDs
En esta parte hay varios estilos.
Uno es usar el nombre del componente y luego aadir su nombre particular:
Nombres de strings
El nombre del string (atributo android:name) lleva antepuesto el nombre de caracterstica a la que
pertenezca y seguido su objetivo.
Ejemplo: login_user_email, list_post_name_filter, machine_detail_temperature.
Si el string es genrico, entonces el prefijo depende del propsito:
Prefijo Propsito
Qu te pareci?
Qu tanta atencin le habas puesto a las reglas de nombrado que usas al desarrollar tus apps?
Mi idea era facilitar el nombrado de los recursos y el cdigo para mantener un orden congruente.
De esta forma sers ms productivo a la hora de escanear tu cdigo y determinar su funcionalidad.
Ojala puedas conseguirlo con esta pequea gua.
Adicionalmente, te dejo algunos links de referencia: