El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència
HOME Els meus cursos Finalitzats
◄ Anterior
◄

Escriure Codi Llegible

Següent ►
►

En aquest tema, aprendrem les millors pràctiques per escriure codi Bash que sigui fàcil de llegir, mantenir i entendre. La llegibilitat del codi és crucial, especialment quan treballes en equips o quan necessites revisar el teu propi codi després d'un temps.

Importància de la Llegibilitat del Codi

  • Mantenibilitat: El codi llegible és més fàcil de mantenir i actualitzar.
  • Col·laboració: Facilita la col·laboració amb altres desenvolupadors.
  • Depuració: Redueix el temps necessari per trobar i corregir errors.
  • Documentació: Serveix com a documentació implícita del que fa el codi.

Bones Pràctiques per Escriure Codi Llegible

  1. Utilitza Noms Descriptius

Els noms de variables, funcions i scripts han de ser descriptius i indicar clarament la seva funció.

Exemple:

# Noms poc descriptius
a=5
b=10
c=$((a + b))

# Noms descriptius
num_apples=5
num_oranges=10
total_fruit=$((num_apples + num_oranges))

  1. Utilitza Comentaris

Els comentaris ajuden a explicar el que fa el codi, especialment en parts complexes o no trivials.

Exemple:

# Calcula el nombre total de fruites
num_apples=5
num_oranges=10
total_fruit=$((num_apples + num_oranges))

# Mostra el resultat
echo "Total fruit: $total_fruit"

  1. Organitza el Codi en Funcions

Divideix el codi en funcions per a tasques específiques. Això fa que el codi sigui més modular i fàcil de seguir.

Exemple:

# Funció per calcular el nombre total de fruites
calculate_total_fruit() {
    local num_apples=$1
    local num_oranges=$2
    echo $((num_apples + num_oranges))
}

# Crida a la funció
total_fruit=$(calculate_total_fruit 5 10)
echo "Total fruit: $total_fruit"

  1. Utilitza Indentació Consistent

L'indentació ajuda a visualitzar l'estructura del codi. Utilitza una indentació consistent per a blocs de codi.

Exemple:

if [ "$condition" == "true" ]; then
    echo "Condition is true"
else
    echo "Condition is false"
fi

  1. Evita l'Ús de Comandes Abreujades

Les comandes abreujades poden ser difícils d'entendre per a altres desenvolupadors. Utilitza comandes completes sempre que sigui possible.

Exemple:

# Comandes abreujades
ls -l
cp file1 file2

# Comandes completes
list_files() {
    ls --long
}

copy_file() {
    cp --verbose file1 file2
}

  1. Utilitza Espais en Blanc

Els espais en blanc ajuden a separar les diferents parts del codi i milloren la llegibilitat.

Exemple:

# Sense espais en blanc
for i in {1..10};do echo $i;done

# Amb espais en blanc
for i in {1..10}; do
    echo $i
done

  1. Evita les Línies de Codi Massa Llargues

Les línies de codi massa llargues poden ser difícils de llegir. Trenca les línies llargues en múltiples línies més curtes.

Exemple:

# Línia massa llarga
echo "This is a very long line of code that is difficult to read and understand because it goes on and on without any breaks."

# Línies més curtes
echo "This is a very long line of code that is difficult to read"
echo "and understand because it goes on and on without any breaks."

Exercici Pràctic

Exercici 1: Millora la Llegibilitat del Codi

Millora la llegibilitat del següent codi aplicant les bones pràctiques que hem après:

a=5;b=10;c=$((a+b));echo $c

Solució:

# Calcula la suma de dues variables
num_apples=5
num_oranges=10
total_fruit=$((num_apples + num_oranges))

# Mostra el resultat
echo "Total fruit: $total_fruit"

Resum

En aquesta secció, hem après la importància de la llegibilitat del codi i diverses bones pràctiques per escriure codi Bash llegible. Hem vist com utilitzar noms descriptius, comentaris, funcions, indentació consistent, espais en blanc, i com evitar línies de codi massa llargues i comandes abreujades. Aquests consells t'ajudaran a escriure codi que sigui més fàcil de mantenir, entendre i col·laborar amb altres desenvolupadors.

◄ Anterior
◄
Següent ►
►
El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència
© Copyright 2024. Tots els drets reservats