Convenciones de nomenclatura en la programación informática

Las convenciones en la programación informática son esenciales para escribir código fácilmente comprensible, ordenado y de calidad.

Por tanto, no es casualidad que sean la base para aprender a programar, ya que sin ellos será muy difícil profundizar en la sintaxis y la semántica de los distintos lenguajes de programación.

Por definición, la naming convention es un conjunto de reglas para elegir la secuencia de caracteres que se utilizará para los identificadores de variables, tipos, funciones y todas las demás entidades en el código fuente y la documentación.

Estas convenciones hacen que cualquier persona pueda leer el código. Dominar este requisito es el primer paso para escribir código de calidad. Independientemente del lenguaje de programación, adoptar una convención de nomenclatura correcta hará que nuestro script sea comprensible para una persona que habla un idioma diferente al nuestro, de otra cultura y que piensa diferente al nuestro.

Es por eso que es importante seguir algunas, pero efectivas, reglas para la redacción del código.

• Coherencia: elige una palabra para elegir un concepto. Mantener la coherencia al escribir código es importante para darle sentido a lo que estás escribiendo, pero también uniformidad y síntesis, por ejemplo:

getName() {…}

retrieveName() {…}

bringBackName() {…}

En este caso, estamos definiendo un método que devuelve el nombre de algo. Aunque escrito de tres formas diferentes, es fácil adivinar que los nombres asignados al método hacen lo mismo. Para aprender a programar es importante ser conciso en cada parte del código que estás escribiendo.

• Significativo: un código legible, como ya hemos dicho, es susceptible de ser entendido por cualquiera que lo lea. Ser conciso no significa escribir palabras cortas o usar identificadores no discursivos. Puede ser explicativo escribiendo las palabras correctas en el contexto correcto. El uso de una convención de nomenclatura que sea demasiado genérica podría ser engañoso para aquellos que leerán nuestro código.

  const USERS; vs const NUMBER_OF_USERS;
  
  const FRIENDS; vs const NUMBER_OF_FRIENDS;
  

¿Ves? Está claro que la nomenclatura adoptada en el lado derecho es más adecuada, ¡especialmente si está declarando constantes inmutables dentro del código!

• Legibilidad: al declarar una variable o definir un método, es importante elegir un término (o más términos) apropiado para lo que refleja esa entidad en el código. Dar un nombre confuso no ayuda a que el código se explique por sí mismo. Al leer una variable o un método, la comprensión de lo que hace ese bloque de código, o lo que es, debe ser instantáneo.

String lblFname; vs String label_first_name;

Usar caracteres extra no nos cuesta nada. Adoptar una nomenclatura como la que se muestra a la izquierda en el ejemplo hace que la variable sea difícil de entender y también difícil de buscar dentro del script si desea volver a ella.

• Abreviaturas: como se mencionó anteriormente, ser firme y conciso en la redacción del código es importante para que sea compacto y comprensible. Para ello es importante saber abreviar los nombres que damos a las entidades en el código. Si necesitamos asignar un nombre a un botón, llamaremos a la variable first_btn en lugar de first_button y adoptaremos esta técnica para todos los nombres asignados dentro del código.
•  Tipos de denominación: a lo largo de los años, la programación informática ha sufrido numerosas evoluciones y cambios. Los desarrolladores y programadores han definido convenciones reales (Case-Notation) que se adoptarán para las entidades dentro del código. Estos son:

1. Camel Case: en esta notación el nombre de la entidad comienza a escribirse con minúscula, pero si la entidad se compone de varias palabras, las siguientes comenzarán con mayúscula:

   firstName oppure countStudents(). 
   

Esta es una de las notaciones más comunes entre los lenguajes de programación, utilizada en el lenguaje Java, en el lenguaje PHP, en el lenguaje C# y en la mayoría de los lenguajes orientados a objetos.

1. Snake Case: al igual que el Camel Case ya mencionado, comienza con la letra minúscula, pero si existen más palabras que dan nombre a la entidad, las siguientes irán precedidas de un guión bajo:

   first_name oppure compute_mean().

Esta notación es más fácil de encontrar en C++, Perl, en el lenguaje Python o R. Junto con la notación mencionada anteriormente, es una de las más utilizadas en el mundo de la programación informática.

1. Pascal Case: se diferencia de las anteriores porque la primera letra ya está en mayúscula. Sea cual sea la entidad a definir, la primera letra siempre irá en mayúscula:

   FirstName, ReverseName().

También se usa a menudo y de buena gana para lenguajes de programación orientados a objetos, nunca se usa en su lugar para el lenguaje Python, C o JavaScript.

1. Kebab Case: es la notación menos utilizada dentro de los lenguajes de programación. Prevé la presencia de un guión, entre la primera y las siguientes palabras, en lugar del guión bajo como se ve en el caso del Snake Case:

   first-name oppure compute-mean().
   

• Agregar metadatos al script: aprender a programar significa ser capaz de hacer que el código sea ilustrativo, en lo que se está haciendo. Proporcionar información adicional se considera una ventaja para quienes escriben código de calidad. Esto puede suceder cuando se logra insertar metadatos en los nombres que proporciona a las entidades en su código. (Por ejemplo, dejar claro mediante el nombre de un método que realiza tareas complejas o cuáles).

Cada uno tiene su forma de escribir código, pero es crucial respetar estas características para tener un script legible. Además, profundizando más y más veremos que cada lenguaje de programación tiene sus propias convenciones. Por ejemplo, en el lenguaje Java las clases y las interfaces deben comenzar con una letra mayúscula, mientras que los métodos y variables con una letra minúscula. En lenguaje Python este no es el estándar y en C las convenciones cambian nuevamente.

¡Recuerda! No respetar ciertas reglas y convenciones corre el riesgo de comprometer la integridad del código, lo que dificulta su comprensión incluso para quienes lo escriben.