5 convenciones de código para una aplicación Android

Mario Alexander Gutierrez Hernández
alex.dev502@gmail.com
Estudiante de Ingeniería en Ciencias y Sistemas - USAC

Palabras clave: Metodología, codigo fuente, java, Android

Al trabajar una aplicación Android en un grupo de trabajo nos topamos, muchas veces, con archivos que nos cuesta entender, variables con nombres extraños, funciones que devuelven cosas raras, codigo sin identacion, etc.

Estos problemas generar un codigo que es dificil de entender para el equipo de trabajo,

incluso para el mismo desarrollador que lo escribio, a lo largo del proyecto

Dirección: Enlace

Estandarizar la escritura del codigo fuente en un proyecto en una aplicación Android, y en proyectos en general, hace que el equipo de trabajo pueda navegar por los diferentes archivos sin ningun inconveniente para comprenderlos.

Es por eso que recomiendo 5 convenciones en Java y Android para escribir nuestro codigo fuente.

1. Nombres de clases

Los nombres de las clases deben ser sustantivos, cuando son compuestos tendrán la primera letra de cada palabra que lo forma en mayúsculas (UpperCamelCase). Intentar mantener los nombres de las clases simples y descriptivos. Usar palabras completas, evitar acrónimos y abreviaturas.

Ejemplo:

class Carro

class DocumentoPersonal

2. Variables

Los nombres de las variables deben ser cortos pero con significado. La elección del nombre de una variable debe ser un mnemónico, designado para indicar a un observador casual su función. Los nombres de variables de un solo carácter se deben evitar, excepto para variables índices temporales. Se debe utilizar la forma de escritura lowerCamelCase, la primera letra minúscula seguido de la primera letra mayúscula de cada palabra.

-Variables globales no publicas y no estáticas deben iniciar con “m”.

Ejemplo:

private int mTotal;

protected String mNombre;

-Variables estáticas deben iniciar con “s”

Ejemplo:

private static Repositorio sRepositorioTrabajo;

-El resto de las variables simplemente utilizan lowerCamelCase

Dirección: Enlace

3. Constantes

Las constantes son valores que no cambian en toda la aplicación, su nombre tiene que ser significativo y con todas sus letras en mayúsculas, separando las palabras con guiones bajos.

Ejemplo:

publc static final int UN_VALOR = 1;

4. Métodos

Los nombres de los métodos deben de ser significativos en base a la acción que realizan, su escritura se debe hacer utilizando el estándar lowerCamelCase.

En cuanto a la longitud de contenido de un método mantenga los métodos pequeños y enfocados. Muchas veces los métodos son de contenido largo y se comprende, por lo que no se establece un límite estricto en la longitud del método. Si un método supera las 40 líneas, hay que considerar si se puede dividir sin dañar la estructura del programa.

5. Comentarios

Comentar el código es de las cosas mas importantes que se deben hacer, los comentarios deben contener información precisa de los componentes mas importantes de cada clase, como mínimo. La forma de comentar el código es utilizar el estándar Javadoc, con este estándar podemos generar incluso un documento con toda la información agregada en los comentarios de nuestro proyecto (clases, métodos, atributos…).

Poniendo en practica los 5 puntos mencionados, empezaremos a ver como el código fuente de la aplicación es cada vez mas legible para el equipo de trabajo, logrando así incluso un avance mas rápido en el desarrollo del proyecto, ya que a cada uno de los programadores se le facilita entender la función de cada porción de código, escrita por cada uno de sus compañeros, si la llegara a necesitar.

Conclusiones:

  • Las convenciones de codigo hacen un codigo mas legible para los programadores, tanto actuales como futuros, del proyecto.

  • Aprender estandares de programacion no solo nos ayudan a trabajar en proyectos locales sino tambien en proyectos globales, que se trabajan en comunidad.

Referencias: