Logo

dev-resources.site

for different kinds of informations.

Clean Code - Funciones

Published at
3/15/2024
Categories
cleancode
softwareengineering
spanish
beginners
Author
Abelardo Ruben Irarr谩zabal D铆az
Clean Code - Funciones

Funciones

Introducci贸n:

La importancia de escribir funciones peque帽as, cohesivas y f谩ciles de entender. Las funciones bien dise帽adas hacen que el c贸digo sea m谩s legible, mantenible y reutilizable.

Principios Clave:

  • Peque帽as: Las funciones deben ser lo m谩s peque帽as posible, idealmente con un m谩ximo de 20-30 l铆neas de c贸digo.
  • Cohesivas: Las funciones deben realizar una 煤nica tarea bien definida.
  • Entradas y salidas: Las funciones deben tener un n煤mero limitado de entradas y salidas bien definidas.
  • Nombres significativos: Los nombres de las funciones deben indicar claramente la acci贸n que realizan.
  • Sin efectos secundarios: Las funciones no deben modificar variables globales o el estado del sistema de forma inesperada.

Ejemplo de Funciones en C#:

Mala Pr谩ctica:

public void CalcularTotalCompra(Cliente cliente, List<Producto> productos) {

  // Calcular el total sin impuestos

  decimal totalSinImpuestos = 0;
  foreach (Producto producto in productos) {
    totalSinImpuestos += producto.Precio;
  }

  // Calcular el impuesto

  decimal impuesto = totalSinImpuestos * 0.15m;

  // Calcular el total

  decimal total = totalSinImpuestos + impuesto;

  // Mostrar el total

  Console.WriteLine("Total: " + total);

}

Beuna Pr谩ctica

public decimal CalcularTotalSinImpuestos(List<Producto> productos) {

  decimal total = 0;
  foreach (Producto producto in productos) {
    total += producto.Precio;
  }

  return total;

}

public decimal CalcularImpuesto(decimal totalSinImpuestos) {
  return totalSinImpuestos * 0.15m;
}

public void MostrarTotal(Cliente cliente, decimal total) {
  Console.WriteLine("Cliente: " + cliente.Nombre);
  Console.WriteLine("Total: " + total);
}

public void CalcularTotalCompra(Cliente cliente, List<Producto> productos) {

  decimal totalSinImpuestos = CalcularTotalSinImpuestos(productos);
  decimal impuesto = CalcularImpuesto(totalSinImpuestos);
  decimal total = totalSinImpuestos + impuesto;

  MostrarTotal(cliente, total);

}

En la buena pr谩ctica:

  • Se han dividido las responsabilidades en funciones m谩s peque帽as y cohesivas.
  • Las funciones tienen nombres significativos que indican la acci贸n que realizan.
  • Las funciones no tienen efectos secundarios.

En la mala pr谩ctica:

  • La funci贸n CalcularTotalCompra es demasiado grande y compleja.
  • La funci贸n realiza varias tareas diferentes, lo que la hace dif铆cil de entender y mantener.
  • La funci贸n modifica variables globales, lo que puede generar errores inesperados.
  • Al escribir funciones peque帽as y cohesivas, el c贸digo se vuelve m谩s legible, mantenible y reutilizable.

Conclusi贸n

Escribir funciones peque帽as, cohesivas y con nombres significativos es una pr谩ctica fundamental para escribir c贸digo limpio. Al seguir los principios y consejos mencionados, puedes mejorar la legibilidad, la mantenibilidad y la reutilizabilidad de tu c贸digo.

Featured ones: