Ak chcete pomôcť ostatným poskytnutím informácií o kóde, musíte použiť komentáre v tom kóde.
Rovnako ako iné programovacie alebo skriptovacie jazyky môžete na účely dokumentácie zadať komentáre v prostredí PowerShell.
V prostredí PowerShell existujú dva typy komentárov:
- Jednoriadkový komentár
- Viacriadkový komentár alebo blok komentárov
Jednoriadkový komentár
Jednoriadkové komentáre sú tie komentáre, do ktorých môžete napísať a hash symbol # na začiatku každého riadku. Všetko napravo od symbolu hash bude ignorované. Ak napíšete viac riadkov v skripte, museli ste použiť symbol hash # na začiatku každého riadku.
Syntax jednoriadkového komentára
Nasledujú dve syntaxe pre jednoriadkový komentár:
reťazcové funkcie java
Syntax1:
#
Syntax2:
#
Príklady
Príklad1: Tento príklad ukazuje, ako použiť komentár na konci riadku
PS C:> get-childitem #this command displays the child items of the C: drive
Príklad2: Tento príklad ukazuje, ako použiť komentár pred kódom a na konci akéhokoľvek príkazu.
javascript pre rozbaľovaciu ponuku
PS C:> #This code is used to print the even numbers from 1 to 10 PS C:> for($i = 1; $i -le 10; $i++) # This loop statement initialize variable from 1 and increment upto 10. >> { >> $x=$i%2 >> if($x -eq 0) # The if condition checks that the value of variable x is equalt to 0, if yes then execute if body >> { >> echo $i # This statement prints the number which is divisibel by 2 >> } >> }
Výkon:
2 4 6 8 10
Viacriadkový komentár
V prostredí PowerShell 2.0 alebo novšom boli zavedené komentáre k viacerým riadkom alebo blokové komentáre. Ak chcete okomentovať viacero riadkov, vložte znak < # symbol na začiatku prvého riadku a #> symbol na konci posledného riadku.
Syntax viacriadkového komentára
Nasledujúci blok zobrazuje syntax viacriadkového komentára:
Statement-1 Statement-2 Statement-N
Príklad: Nasledujúci príklad popisuje, ako používať viacriadkový komentár v kóde.
PS C:> <# this code is used to print the>> factorial of a given number#> PS C:> $a=5 PS C:> $fact=1 PS C:> for ($i=$a;$i -ge 1;$i--) >> { >> $fact=$fact * $i; >> } </#>
Ak chcete zobraziť výstup z vyššie uvedeného príkladu, zadajte nasledujúci príkaz:
PS C:> $fact 120