Tipos de notación y estilo de programación. Formas de nombrar a las variables, funciones, ...

Notación y estilo en programación

Algunas personas no tienen en cuenta el estilo cuando escriben sus programas, resulta curioso, que esas mismas personas son a menudo las primeras en quejarse cuando reciben un programa escrito por otro y que resulta incomprensible. Para mejorar la legibilidad del código, es importante tener presentes unas pocas normas de estilo, que pueden variar según el lenguaje que se use. Vamos a repasarlas en este artículo.

Notaciones para identificadores

En programación, un identificador es un nombre que el programador asigna a una variable, un subprograma (función/procedimiento o método), a una estructura o a una clase. La mayor parte de lenguajes de programación admiten letras, números y el caracter _ en sus identificadores, con la condición de que no pueden empezar con un número. A parte de esto, permiten al programador elegir la notación que mas le convenga. Algunos lenguajes, sugieren explícitamente una notación determinada, como Java y la notación Camel. Sea cual sea la notación que se elija, es conveniente mantenerla en un mismo programa.

Una de las recomendaciones mas importantes de la programación con estilo, es usar nombres cortos en identificadores locales, y nombres largos y descriptivos en identificadores globales. Normalmente se usarán verbos activos (getXX, setYY, parseZZ...) para subprogramas, y nombres descriptivos para variables, estructuras y clases. Estos nombres largos se forman habitualmente de mas de una palabra, y debido a que los lenguajes de programación no admiten el espacio en sus identificadores, hay que buscar alternativas para escribirlos.

Ignorar simplemente los espacios no es una buena opción, porque reduce la legibilidad del identificador: “end of file” → “endoffile”. En COBOL se eligió separar los identificadores con guiones: END-OF-FILE, sin embargo esta notación no es posible en los lenguajes actuales, ya que el guión se utiliza como operador de resta y no se admite en identificadores. Las notaciones mas utilizadas en la actualidad son las siguientes:

Notación Camel

La notación Camel consiste en escribir los identificadores con la primera letra de cada palabra en mayúsculas y el resto en minúscula: EndOfFile. Se llama notación “Camel” porque los identificadores recuerdan las jorobas de un camello. Existen dos variantes:
  • UpperCamelCase, CamelCase o PascalCase: en esta variante la primera letra también es mayúscula.
  • lowerCamelCase, camelCase o dromedaryCase: la primera letra es minúscula.
En el lenguaje Java, se usa la notación CamelCase en identificadores para clases, y dromedaryCase para métodos y variables. La notación Camel se utiliza también en publicidad y marcas comerciales: PlayStation, easyJet, ...

Notación C

Durante los años 1960s, con la estandarización del código ASCII, los primeros programadores de C y UNIX utilizaron el carácter _ como separador: end_of_file. Esta notación sigue siendo la mas utilizada en C y entornos UNIX. Los defensores de esta notación argumentan que es mas fácil de leer porque deja un espacio entre palabras, al contrario que Camel. Además, en algunos teclados es mas rápido de escribir el carácter _ que una mayúscula.

Notación Húngara

La notaión Húngara se basa en Camel, añadiendo al principio del identificador una secuencia de letras en minúscula, que indica alguna característica del identificador, como su tipo en el caso de variables. Por ejemplo:
  • iValue podría denotar una variable entera.
  • fValue una variable float.
  • frmPartner la instáncia de un formulario.

Notación para constantes

En muchos lenguajes de programación, se tiene la costumbre de denotar las constantes mediante identificadores en mayúsculas. En este caso la notación Camel no es aplicable y solo queda usar la notación C: END_OF_FILE, PI, EARTH_RADIUS, etc. Java recomienda esta notación para constantes, y en C/C++ siempre ha sido la notación mas usada.

Notación para miémbros privados

En lenguajes como JavaScript, sin soporte directo a la orientación a objetos, donde no existe la posibilidad de declarar miembros privados, se suele usar el carácter _ delante del identificador que se considera “privado”: _private_member. Se trata de una simple indicación para no usar el miembro de forma pública por error. En Python o en librerías C también se usa esta notación.

Referencias

No hay comentarios:

Publicar un comentario

Gracias por comentar en mi blog. Saludos.