01 febrero, 2013

Guía de estilo para MATLAB: Nomenclatura

En la nomenclatura de variables y funciones en MATLAB uso las siguientes convenciones

Contenido

Variables

  • Los nombres de las variables se escriben en español
  • Deben ser nombres descriptivos y sin abreviaturas; generalmente, serán nombres largos.
  • La primer letra de cada palabra en mayúsculas, excepto en la primer palabra (lowerCamelCase). Ejemplos: tiempo, distanciaHorizontal, perroGris
  • Si la variable es una estructura también la primer letra de la primer palabra es mayúscula (UpperCamelCase). Ejemplos: PerroGris.estatura, PerroGris.nombreCompleto, PerroGris.ComidaFavorita.desayuno
  • Si la variable representa el número total de elementos de un conjunto se usa el prefijo n. Ejemplos: nArchivos, nPerros
  • Si la variable se usa para iterar se utiliza el prefijo i. Ejemplo: for iPerro = 1:nPerros, ... , end
  • Para variables lógicas se usa el prefijo es. Ejemplos: esPerro, esGato
  • Si la variable es el índice de un arreglo se usa el prefijo ind. Ejemplo: indPerro = find(esPerro)
  • Se indican la unidades de las variables con un sufijo separado del nombre de la variable por un guion bajo. Ejemplos: distancia_m, peso_kg, tiempo_s

Funciones

  • Los nombres de las funciones se escriben en inglés
  • El nombre debe estar compuesto por un verbo seguido de un objeto. Ejemplos: processData(), petDog(). Si la función realiza tantas tareas que no sabes cual verbo escoger entonces tu función es incorrecta; cada función debe realizar una única acción y la debe hacer bien.
  • Si la función cambia el formato del argumento de entrada se usa la notación input2output. Ejemplos: jpg2bmp(), txt2pdf(), lbs2kg()
  • Las funciones que calculan un sólo dato de salida se pueden nombrar como ese dato (para evitar tener demasiadas funciones con el prefijo compute). Ejemplos: promedio = mean(datos), cuadrado = square(numero)
  • Si la función devuelve valores lógicos se usa el prefijo is. Ejemplos: esPerro = isDog(perroGris)

Referencia