Consejos de programación

Consejos generales sobre cómo escribir buen código


Cómo nombrar una función

Elegir buenos nombres de función es una parte esencial de escribir buen código. Ten en cuenta las siguientes recomendaciones cuando le pongas nombre a tu función.

Elige nombres de función significativos

Cuando le pongas nombre a tu función, debes tener claro qué hace. Por ejemplo, la función get(studentId, subject) no tiene un nombre de función significativo y, por lo tanto, no queda claro qué hace. Podría estar obteniendo la calificación del estudiante en la materia o su estado de inscripción. Un mejor nombre sería getStudentGrade(studentId, subject), ya que comunica con precisión qué hace la función.

No hagas que el nombre de la función sea demasiado largo

Ten cuidado de no hacer que el nombre de una función sea demasiado largo. Por ejemplo, checkStudentFailOrPassOrMeritOrDistinction(mark) es un nombre de función innecesariamente largo. Cuanto más largo es el nombre, más difícil resulta recordarlo y más espacio ocupa en la pantalla de la computadora.

No hagas que el nombre de la función sea demasiado corto

Por el contrario, hacer que el nombre de una función sea demasiado corto también puede confundir a los lectores. Por ejemplo, checkFPMD(mark) es un mal nombre de función, ya que no es evidente de inmediato qué significa «FPMD».

Usa el nombre que todos entiendan

Cualquiera que lea tu código debería poder entender el nombre de tu función. Por ejemplo, un nombre de función poco claro como DeathStar() puede resultarte divertido, pero el nombre no comunica su propósito y puede confundir a otros desarrolladores que lean tu código.

Elige una sola convención para nombrar operaciones

Mantén una sola convención para nombrar las operaciones que hacen lo mismo. Por ejemplo, si nombras la función para obtener el nombre de un estudiante getStudentName(), no deberías usar un verbo diferente en el nombre de la función para obtener la calificación de un estudiante (por ejemplo, retrieveStudentGrade()).

Evita usar la misma palabra para dos propósitos

Por ejemplo, no sigas usando add cuando quieras poner un grupo de elementos en una colección si ya usaste ese nombre para la suma de dos números. Usa insert o append en su lugar.