Consejos generales sobre cómo escribir buen código
Elegir buenos nombres de función es una parte esencial de escribir buen código. Ten en cuenta las siguientes recomendaciones cuando nombres tu función.
Cuando nombres tu función, deberías 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 nota de una asignatura del estudiante o consultando su estado de matrícula.
Un nombre mejor sería getStudentGrade(studentId, subject), ya que comunica con precisión qué hace la función.
Procura 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 sea el nombre, más difícil resulta recordarlo y más espacio ocupa en la pantalla del ordenador.
A la inversa, 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».
El nombre de tu función debería ser comprensible para cualquiera que lea tu código.
Por ejemplo, un nombre de función rebuscado como DeathStar() puede resultarte divertido, pero el nombre no comunica su propósito y puede causar confusión a otros desarrolladores que lean tu código.
Cíñete a una única convención para nombrar 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 distinto en el nombre de la función para obtener su nota (p. ej., retrieveStudentGrade()).
Por ejemplo, no sigas usando add cuando quieras meter un grupo de elementos en una colección si ya lo has usado para la suma de dos números.
Usa insert o append en su lugar.