Skrypty PowerShell – bez komentarza!?

Jak często zostawiasz swoje skrypty PowerShell bez komentarza? Co prawda spotkałem się z opinią, że dobrze napisany i sformatowany kod nie wymaga dodatkowych komentarzy. Jednak mimo wszystko warto zostawić kilka słów wyjaśniających naszą twórczość.

Komentarze w PowerShell

W PowerShell mamy do dyspozycji dwa rodzaje komentarzy w kodzie PowerShell – komentarze liniowe oraz blokowe.

Pierwszy to oznaczenie pojedynczej linii jako komentarz poprzez dodanie znaku # (hash). Taka linia jest ignorowana w momencie wykonywania skryptu.

Druga z opcji to utworzenie bloku komentarza. Blok otwierasz znakami <# i zamykasz #>. Wszystko pomiędzy tymi znakami to po prostu informację dla poprawiających nasz kod 😉

Komentarze w Visual Studio Code

Ze względu, na to, że Visual Studio Code zrobił się pierwszym wyborem edytora skryptów PowerShell poniżej dwa skróty klawiszowe do dodawania komentarzy.

Skróty klawiszowe w VSCode:

⌨️ Pojedyńcza linia komentarza – Ctrl + /

⌨️ Blok komentarza – Shift + Alt + A

Better Comment

W Visual Studio Code do dyspozycji mamy mnóstwo rozszerzeń, również można coś znaleźć związanego z komentarzami. Jednym wartym uwagi jest Better Comment, który podrasuje nasze komentarza.

W prosty sposób dodatkowo uwypuklisz (po hashu dodaj odpowiedni oznaczenie – *, !, ? lub TODO), kluczowe komentarze w skrypcie PowerShell (ale też innych językach programowania).

Podsumowanie

Prosty, ale istotny temat przede wszystkim dla osób zaczynających przygodę z PowerShell. Oprócz standardowego zastosowania komentowanie wykorzystaj do wykluczania wykonywania fragmentu kodu, np podczas testowania.

Jeśli nie czytałeś jeszcze 7 podstawowych praktyk PowerShell (jedna związana z komentowaniem) to zapraszam do przeczytania.