Java: Linter
Ahora que ya hemos aprendido a escribir programas simples, podemos hablar un poco sobre cómo escribirlos.
El código del programa debe ser formateado de una manera específica para que sea lo suficientemente comprensible y fácil de mantener.
Conjuntos especiales de reglas, llamados estándares, describen varios aspectos de la escritura de código. En Java, el estándar más común es el estándar de Sun.
En cualquier lenguaje de programación, existen utilidades llamadas linters. Estas verifican el código para asegurarse de que cumpla con los estándares. En Java, esto se hace con checkstyle. Echa un vistazo a este ejemplo:
System.out.println( "Hello, World!" ); System.out.println("I'm a developer!") ;
El linter mostrará errores en varios lugares:
- '(' está seguido de un espacio en blanco. [ParenPad]
- ')' está precedido de un espacio en blanco. [ParenPad]
- ';' está precedido de un espacio en blanco. [NoWhitespaceBefore]
- Solo se permite una instrucción por línea. [OneStatementPerLine]
Analicemos estos errores:
- La regla ParenPad, indicada entre corchetes, requiere que no haya espacios después del paréntesis de apertura y antes del paréntesis de cierre.
- La regla NoWhitespaceBefore indica que no se debe colocar un espacio adicional antes del punto y coma.
- Es común escribir cada nueva instrucción en una nueva línea. Esto es lo que indica la regla OneStatementPerLine.
Cumplir con estas reglas no afecta el resultado, pero ayuda a escribir un código más comprensible y fácil de entender.
El código con estas reglas se vería así:
System.out.println("Hello, World!");
System.out.println("I'm a developer!");
Ahora el linter no mostrará errores. ¿Qué conclusión podemos sacar? El linter ayuda a escribir código que es más fácil de leer y analizar.
Recuerda que tener un linter no reemplaza el análisis y la simplificación independiente del código. En tus futuras prácticas en Hexlet y en el desarrollo real, el linter funcionará y te informará sobre cualquier violación.
Tarea
Muestra en pantalla el resultado de la siguiente operación: "la diferencia entre la suma de cinco y dos y el producto de tres y siete". Compara el resultado obtenido con la solución del profesor en términos de formato del código.
¿El ejercicio no pasa la prueba, qué debo hacer? 😶
Si te quedaste atascado, es el momento perfecto para hacer una pregunta en las "Discusiones".
* Asegúrate de incluir la salida de las pruebas. Sin ella, es casi imposible entender qué está mal, incluso si muestras tu código. Los programadores tienen dificultades para ejecutar el código en su mente, pero casi siempre es posible entender a dónde mirar a partir del error que recibiste.
Mi código funciona en mi entorno, pero no aquí 🤨
Las pruebas están diseñadas de manera que verifican la solución de diferentes maneras y con diferentes datos. A menudo, una solución funciona con ciertos datos de entrada pero no con otros. Para entender este punto, revisa la pestaña "Pruebas" y presta atención a los mensajes de error, que suelen contener pistas.
Mi código es diferente a la solución del profesor 🤔
Esto es normal 🙆. En programación, una tarea puede tener muchas soluciones diferentes. Si tu código pasa la prueba, cumple con los requisitos de la tarea.
En raras ocasiones, la solución puede estar ajustada para pasar las pruebas, pero esto suele ser evidente.
Leí la lección, pero no entendí nada 🙄
Crear materiales de aprendizaje comprensibles para todos es bastante difícil. Hacemos nuestro mejor esfuerzo, pero siempre hay margen para mejorar. Si encuentras material que no entiendes, describe el problema en las "Discusiones". Es ideal si puedes formular los aspectos que no entiendes en forma de preguntas. Por lo general, necesitamos unos días para hacer mejoras.
Por cierto, tú también puedes contribuir a mejorar los cursos: en la parte inferior hay un enlace al código fuente de las lecciones, que se puede modificar directamente en el navegador.