Categories: All - modularidad - reutilización - nomenclatura - formato

by Claudia Patricia Martínez Pérez 3 years ago

188

Código limpio

El código limpio es esencial para garantizar que otros desarrolladores puedan leer, entender y modificar el código sin necesidad de hacer preguntas adicionales. Esto facilita la colaboración y acelera el desarrollo, ya que permite la reutilización, depuración, y revisión del código con mayor eficiencia.

Código limpio

Código limpio

fácil de leer y entender para otros desarrolladores.

Lenguaje adecuado
enfatiza en:

Modularidad para facilitar las pruebas y la reutilización

Organización general para comunicar la intención y hacer las cosas más fáciles de encontrar

En teoría, otros desarrolladores deberían poder entender, usar y modificar su código sin necesidad de hacerle preguntas. Esto acelera enormemente el desarrollo, permitiendo la reutilización, depuración, análisis de seguridad, revisión de código y fusión, junto con otros procesos. Permite que los proyectos de larga data (por ejemplo, proyectos de código abierto) incorporen su código con mayor confianza. Y permite a las organizaciones seguir utilizando su código de manera eficiente, después de haber pasado a otros proyectos o trabajos.

El código que no está limpio se convierte rápidamente en deuda técnica. Puede ser insostenible, o inutilizable con total confianza. Es un código que necesita ser refactorizado, o eliminado y reescrito, lo cual es costoso y requiere mucho tiempo.

Razones para escribir un código limpio:

Es más fácil de escanear y verificar utilizando herramientas automatizadas como linters, o herramientas de línea de comandos como grep, awk y sed.

Al ser modular, tiende a ser más fácil de probar utilizando métodos automatizados como marcos de pruebas unitarias.

Simplemente se ve mejor.

Métodos vs. Funciones

La diferencia entre métodos y funciones es que las funciones son bloques de código independientes, mientras que los métodos son bloques de código asociados con un objeto, típicamente para la programación orientada a objetos.

módulos y clases

Declaraciones de Retorno

Se denomina con la palabra clave "return", seguido de una variable o expresión. Este se da asociado a la tarea realizada por los métodos y funciones, el cuál realiza el proceso de return devolviendo el valor de dicha función e ignorando cualquier código que halla en continuidad. Es el trabajo de la línea de código que llama al método o función para tomar el valor de la devolución, pero no es obligatorio.

Una versión de código que utilice funciones, parámetros y argumentos da como resultado código no duplicado. Además, al usar funciones, puede etiquetar bloques de código, lo que hace que sus propósitos sean más comprensibles.

Argumentos y parámetros

Los métodos y funciones realizan tareas. Algunos requieren que el tipo de datos se defina en el parámetro (los llamados lenguajes "strongly typed'"), mientras que algunos lo permiten opcionalmente. Hace que el código sea más fácil de reutilizar porque puedes ver más fácilmente qué tipo de parámetros espera un método o función. También hace que los mensajes de error sean más claros. Los parámetros y argumentos añaden flexibilidad a los métodos y funciones.

Una función, una cadena, un entero (o número), y un objeto que contiene una clave y un valor.

métodos y funciones

Son bloques de código que realizan tareas cuando se ejecutan. Si el método o la función no se ejecuta, esas tareas no se realizarán.

El código que realiza una tarea discreta, incluso si ocurre una sola vez, puede ser un candidato para la encapsulación.

El código de tarea que se usa más de una vez probablemente debería encapsularse. Si se encuentra copiando varias líneas de código, probablemente necesite ser un método o función.

Lo más poderoso de los métodos y funciones es que pueden escribirse una vez y ejecutarse tantas veces como se desee. Si se usan correctamente, los métodos y funciones simplificarán su código y, por lo tanto, reducirán el potencial de errores.

Fácil de entender, más compacto y mejor organizado.

Formato estandarizado y nomenclatura intuitiva para facilitar la lectura, comprensión y búsqueda

Respeto espacios al pegar

Lenguaje comprensible

sangría en los lugares correctos

Formato coherente para la sintaxis, como la ubicación de llaves ({})