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

Escriptura de Codi Llegible i Mantenible

Següent ►
►

En aquest tema, aprendrem les millors pràctiques per escriure codi PowerShell que sigui fàcil de llegir, entendre i mantenir. La llegibilitat i la mantenibilitat són aspectes crucials per assegurar que el codi pugui ser utilitzat i modificat per altres desenvolupadors (o per tu mateix en el futur) sense dificultats.

Importància de la Llegibilitat i la Mantenibilitat

Per què és important?

  • Facilitat de Manteniment: El codi llegible és més fàcil de mantenir i actualitzar.
  • Col·laboració: Facilita la col·laboració entre diferents desenvolupadors.
  • Depuració: Redueix el temps necessari per trobar i corregir errors.
  • Escalabilitat: Permet que el codi creixi i s'adapti a noves necessitats amb menys esforç.

Bones Pràctiques per a la Llegibilitat

  1. Utilitza Noms Descriptius

Els noms de variables, funcions i scripts han de ser descriptius i autoexplicatius.

Exemple:

# Noms poc descriptius
$fn = "John"
$ln = "Doe"

# Noms descriptius
$firstName = "John"
$lastName = "Doe"

  1. Comenta el Codi

Els comentaris ajuden a explicar el propòsit del codi, especialment en parts complexes.

Exemple:

# Calcula la suma de dos números
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

  1. Utilitza Espais en Blanc i Indentació

L'ús adequat d'espais en blanc i la indentació milloren la llegibilitat del codi.

Exemple:

# Sense espais en blanc i mala indentació
function Get-Sum{param([int]$a,[int]$b)return $a+$b}

# Amb espais en blanc i bona indentació
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

  1. Segueix un Estil Consistent

Adopta un estil de codificació consistent per a tot el projecte.

Exemple:

# Estil inconsistent
function Get-Sum {
    param ([int]$a, [int]$b)
    return $a + $b
}
function getdifference {
    param([int]$a,[int]$b)
    return $a-$b
}

# Estil consistent
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

function Get-Difference {
    param (
        [int]$a,
        [int]$b
    )
    return $a - $b
}

Bones Pràctiques per a la Mantenibilitat

  1. Modularitza el Codi

Divideix el codi en funcions i mòduls petits i reutilitzables.

Exemple:

# Funció per sumar dos números
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

# Funció per restar dos números
function Get-Difference {
    param (
        [int]$a,
        [int]$b
    )
    return $a - $b
}

  1. Evita la Duplicació de Codi

Reutilitza funcions i mòduls en lloc de duplicar codi.

Exemple:

# Codi duplicat
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

function Get-Total {
    param (
        [int]$x,
        [int]$y
    )
    return $x + $y
}

# Codi reutilitzat
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

function Get-Total {
    param (
        [int]$x,
        [int]$y
    )
    return Get-Sum -a $x -b $y
}

  1. Escriu Proves

Escriu proves per assegurar que el codi funcioni correctament i per facilitar la detecció d'errors.

Exemple:

# Prova per a la funció Get-Sum
function Test-Get-Sum {
    $result = Get-Sum -a 2 -b 3
    if ($result -eq 5) {
        Write-Output "Test passed"
    } else {
        Write-Output "Test failed"
    }
}

Test-Get-Sum

  1. Documenta el Codi

Proporciona documentació detallada sobre com utilitzar les funcions i scripts.

Exemple:

<#
.SYNOPSIS
    Calcula la suma de dos números.
.DESCRIPTION
    Aquesta funció pren dos números enters com a paràmetres i retorna la seva suma.
.PARAMETER a
    El primer número.
.PARAMETER b
    El segon número.
.EXAMPLE
    PS> Get-Sum -a 2 -b 3
    5
#>
function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

Exercicis Pràctics

Exercici 1: Millora la Llegibilitat

Millora la llegibilitat del següent codi:

function add($x,$y){return$x+$y}
function sub($x,$y){return$x-$y}

Solució:

function Add-Numbers {
    param (
        [int]$x,
        [int]$y
    )
    return $x + $y
}

function Subtract-Numbers {
    param (
        [int]$x,
        [int]$y
    )
    return $x - $y
}

Exercici 2: Modularitza el Codi

Modularitza el següent codi per evitar la duplicació:

function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

function Get-Total {
    param (
        [int]$x,
        [int]$y
    )
    return $x + $y
}

Solució:

function Get-Sum {
    param (
        [int]$a,
        [int]$b
    )
    return $a + $b
}

function Get-Total {
    param (
        [int]$x,
        [int]$y
    )
    return Get-Sum -a $x -b $y
}

Resum

En aquesta secció, hem après la importància de la llegibilitat i la mantenibilitat del codi PowerShell. Hem revisat bones pràctiques com utilitzar noms descriptius, comentar el codi, utilitzar espais en blanc i indentació, seguir un estil consistent, modularitzar el codi, evitar la duplicació, escriure proves i documentar el codi. Aquests consells t'ajudaran a escriure codi que sigui fàcil de llegir, entendre i mantenir, millorant així la qualitat del teu treball i facilitant la col·laboració amb altres desenvolupadors.

◄ Anterior
◄
Següent ►
►

Curs de PowerShell

Mòdul 1: Introducció a PowerShell

Mòdul 2: Scripting Bàsic

Mòdul 3: Treballant amb Objectes

Mòdul 4: Tècniques Avançades de Scripting

Mòdul 5: Automatització i Programació de Tasques

Mòdul 6: Remotització amb PowerShell

Mòdul 7: Funcions Avançades de PowerShell

Mòdul 8: PowerShell i DevOps

Mòdul 9: Millors Pràctiques i Consells Avançats

El Projecte | Sobre nosaltres | Contribuir | Donacions | Llicència
© Copyright 2024. Tots els drets reservats