Al revisar el código de un compañero de trabajo, encontré algunos errores ortográficos en los nombres de funciones y también errores gramaticales como 'doesUserHasPermission ()' en lugar de 'doesUserHavePermission ()' en los nombres de funciones y variables.
¿Debo señalarle esto a él o estoy siendo demasiado pedante al notar esto?
El código con errores ortográficos y gramaticales es no mantenible .
La gente no recordará la mala gramática, por lo que intentarán llamar a la función como debería haber sido escrita, y así es como ocurren los errores.
No puedes grep para algo en el código si no sabes cómo se deletrea.
La mayoría de las personas que hacen gramática / ortografía lo hacen de manera inconsistente, por lo que introducirán muchos errores con nombres no coincidentes. Esto es particularmente problemático en los idiomas que no requieren que las variables se declaren explícitamente antes de su uso, ya que puede introducir una nueva ortografía y su código no se detendrá para informarle que cometió errores.
Corregir estos problemas no es pedante, ni es necesario principalmente por las opiniones de los demás sobre la inteligencia, la alfabetización, etc. (aunque eso es un gran efecto secundario); se trata de escribir calidad, código de mantenimiento .
Sí, definitivamente. Es más fácil recordar el nombre si es gramaticalmente correcto. Tratar de recordar el nombre de los errores gramaticales y es otra cosa completamente.
No los señale como defectos en una revisión formal del código. En su lugar, marque una lista y hable con él de forma PRIVADA sobre ellos. Sea lo más diplomático posible al respecto, solo "Oye, algo que noté, y me he topado con personas que REALMENTE desprecian este tipo de cosas, piensan que hace que el programador se vea descuidado y descuidado".
Si este es el código que un cliente va a ver, DEBE corregirse. Nos guste o no, se refleja en la reputación de su empresa.
Para el ejemplo que dio, sospecho que comenzó como UserHasPermission, y alguien más le dijo que la práctica local era doesUserBlahBlah () en lugar de UserBlahBlah (), y él simplemente pasó por alto el cambio de gramática.
Cámbialo tú mismo.
Esperamos que estés en un entorno donde el código de "propiedad" no sea un problema. Si tiene acceso al proyecto en el control de código fuente, solo ingrese y corríjalo usted mismo. Si ve a un compañero de trabajo en particular cometiendo el mismo tipo de errores gramaticales o ortográficos de manera constante, es posible que desee señalarlo, pero eso dependerá de su relación, si la persona es un hablante nativo de inglés y su receptividad general. Pero si alguna vez decides hacer eso o no, simplemente ve y haz la corrección. Hago esto todo el tiempo, si veo un error tipográfico, especialmente en una firma de método o propiedad pública, simplemente lo arreglo. De vez en cuando ni siquiera puedo resistir la tentación de corregir un error tipográfico en un comentario, pero eso es solo yo :)
Soy un desarrollador cuyo idioma nativo no es el inglés, en realidad es holandés, y no me importaría en absoluto si alguien me señalara un error de gramática o ortografía. De esa manera puedo seguir mejorando constantemente mi inglés. Y ciertamente no es difícil corregir todos los errores en todo el código fuente. Un simple script de Perl se puede escribir fácilmente para recorrer todos los archivos en una carpeta. Tal vez incluso se puede hacer con sed? No lo sé.
Por lo tanto, sin duda señalaría errores gramaticales o ortográficos en el código de otra persona, pero solo si estoy absolutamente seguro de si es correcto lo que estoy diciendo.
Creo que vale la pena mencionar aquí que el encabezado de referencia HTTP en el protocolo HTTP fue mal escrito como "referente" (y tenemos que vivir con él / hemos aprendido a vivir con él.) :)
Estoy de acuerdo con otras respuestas que dicen que el código con errores gramaticales no se puede mantener.
También quiero añadir algunas cosas:
Recomendaría usar un IDE con un corrector ortográfico incorporado. IntelliJ Idea hace un trabajo maravilloso para los programas de Java. Hay muchos errores tipográficos vergonzosos que atrapa, no solo en los nombres de funciones, sino en, por ejemplo, mensajes de excepción que el usuario puede ver. Un programa que produce mensajes llenos de errores tipográficos no inspira mucha confianza.
Lo hago solo si
Como nota al margen, si los nombres de sus funciones son lo suficientemente largos para tener gramática, probablemente sean demasiado largos. En el ejemplo dado, llamaría a la función userHasPermission y movería la "gramática" a su código, algo como esto:
if userHasPermission() ...
Esto también sucede MUCHO en mi proyecto (está poblado por personas de habla hebrea, rusa o árabe), pero incluso a un nivel más alto, a menudo veo un código que usa una terminología poco clara que resulta ser lo que el diccionario produjo como la traducción para lo que el autor tenía en mente, y no tiene nada que ver con lo que significaban ...
Personalmente, cuando sucede con tanta frecuencia y por tantos miembros del equipo que podrían haber escrito el código incluso antes de unirme al proyecto, tiendo a ignorarlo, porque no importa.
Sin embargo, si estoy realizando algún trabajo en el mismo archivo que el código o los comentarios que se han escrito hace mucho tiempo y tienen errores tipográficos, los corregiré solo porque no es demasiado trabajo.
Se aplica la regla de oro
Haz a los demás como te gustaría. hazte.
Quiero que otros tengan mi espalda en este tipo de cosas, así que ayudo a otros. Ser amable y solidario puede hacer mucho a tu favor.
Al igual que con muchas otras buenas prácticas de programación, la única forma objetiva, no política y efectiva de implementar una política sobre ortografía en los programas es automatizarla como parte del proceso de pre-confirmación. La automatización le ahorrará enormes cantidades de quejas, incluso si tiene que escribir su propia herramienta para este propósito.
Este es un error menor en el código, pero es un error. Trátalo como cualquier otro error que encuentres. Mi política siempre es asumir que mis compañeros de trabajo son competentes y tratarlos de esa manera hasta que demuestren lo contrario.
Si es un solo error, podría corregirlo y registrarlo. Si es un patrón, es posible que empiece a hacer que ese compañero de trabajo revise esas correcciones. Hazles saber que crees que son un buen programador, pero que esto es algo que sería bueno mejorar. Sin embargo, no creo que alguna vez haga un gran problema con algo como esto.
Mientras no lo trates como si fuera un gran problema, debería ser fácil poner a ese compañero de trabajo en una posición en la que puedan mejorar sin poner el ego en la línea.
userPermission () quizás? -
El último que encontré fue un problema global en el que los resultados de búsqueda no se resaltaban porque el nombre de la clase estaba escrito en un punto destacado. Error muy oscuro para detectar.
Claro, señálelo, pero no pierda el tiempo buscando errores de ortografía. Utilice una herramienta para automatizar esto en su CI. En .net fxCop puede hacer esto ...
Depende en gran medida de cuáles sean los errores, qué tan comunes y cuán malos son, y si en realidad es un error de buena fe o simplemente no cómo lo dirías.
Personalmente, no lo soporto cuando un idiota arrastra una revisión de código de 5 minutos hasta media hora porque quiere que todo cambie su nombre y cómo todos los comentarios se vuelvan a redactar solo porque le gusta meter el remo. Una línea de registro que dice "Cargar objetos de datos" no debe cambiarse a "El componente del cargador de objetos de datos ahora cargará los objetos de datos relevantes desde el componente de almacenamiento de objetos de datos".
/ rant :)
Lea otras preguntas en las etiquetas code-reviews grammar