Hvordan lage beskrivende PowerShell -kommentarer

PowerShell Scripting støtter kommentarer for å legge til menneskelig lesbare instruksjoner. Mer spesifikt legges kommentarer til skriptet for feilsøkings- og dokumentasjonsformål. Disse beskrivende kommentarene hjelper andre programmerere til å forstå koden tydeligere. Beskrivende kommentarer kan være enkeltlinje- eller flerlinjekommentarer.

Denne oppskrivningen vil diskutere flere metoder for å lage beskrivende kommentarer.

Hvordan lage beskrivende PowerShell -kommentarer?

I PowerShell kan de beskrivende kommentarene opprettes ved hjelp av de under-nevnte metodene:

• Enkeltlinje beskrivende kommentarer.
• Multiline beskrivende kommentarer.

Metode 1: Enkeltlinje beskrivende kommentarer

Enkeltlinje kommentarer kan opprettes for å legge til kodebeskrivelser ved å bruke “#" emneknagg. Teksten skrevet sammen med hashtaggen vil bli betraktet som kommentaren. Disse kommentarene brukes til å legge til mindre kodebeskrivelser.

Eksempel
Dette eksemplet vil demonstrere å legge til en enkelt linjekommentar i PowerShell -skriptet:

# Dette er en enkelt linje kommentar.
Skriv-vert "beskrivende kommentar vil ikke vises.""
# Enkelt linje beskrivende kommentar

I henhold til koden ovenfor:

• Først må du lage en enkeltlinjekommentar ved hjelp av "#" emneknagg.
• Etter det, spesifiser “Skriv-verten”Cmdlet for å legge til en strenglinje.
• Til slutt, legg til enkeltlinjekommentaren:

Det kan observeres at den enkeltlinje beskrivende kommentaren er lagt til vellykket, og at den ikke vises i PowerShell-konsollen.

Metode 2: Multiline beskrivende kommentarer

Kommentarer ser bra ut når de er korte og konsise, men det kommer behov for å skrive detaljerte beskrivende kommentarer. Disse kommentarene kalles multiline- eller kommentarblokker. Mer spesifikt starter multiline kommentarer eller kommentarblokker med dette symbolet "<#”Og slutt med dette“#>”Symbol. Alt skrevet i disse symbolene vil bli betraktet som multi-line beskrivende kommentarer.

Eksempel
Dette eksemplet vil illustrere opprettelsen av multiline kommentarer i PowerShell:

<# Description
av koden
kan legges til her
#>
Skriv-vert "Dette er et flerlinje kommentareksempel.""

I henhold til koden ovenfor:

• Først må du legge til multiline -kommentaren innen start "<#”Og slutt”#>”Symboler.
• Etter det la vi til “Skriv-verten”Cmdlet for å legge til en strenglinje:

Den flerlinje beskrivende kommentaren ble lagt til vellykket, og den viste ikke i PowerShell-konsollen.

Konklusjon

Den beskrivende kommentaren i PowerShell kan opprettes ved hjelp av enkeltlinje- og flerlinjekommentarer. Enkeltkommentarer kan opprettes ved å legge til hashtaggen "#”Hashtag i starten av linjen. Mens kommentarer med flere linjer blir opprettet i "<#”Starter og“#>”Avsluttende symboler. Denne bloggen har utdypet en detaljert guide for å lage beskrivende PowerShell -kommentarer.