Jak komentować w Ruby

W pewnym momencie każdy programista znajduje się w sytuacji, w której musi zmodyfikować kod źródłowy skryptu. Bez odpowiedniej dokumentacji i informacji, które Cię poprowadzi, robi to prawie niemożliwe. Właśnie tam wchodzi koncepcja komentowania twojego kodu.

Komentarze to po prostu informacje dodane do kodu źródłowego programu do celów dokumentacji. Tłumacze i kompilatorzy ignorują komentarze. Chociaż głównym użyciem komentarzy jest dokumentowanie i opisanie operacji bloku kodu, mogą być wygodne podczas debugowania kodu.

W tym samouczku poznamy różne sposoby komentowania kodu w skryptach Ruby.

Podstawowe użycie: komentarze z pojedynczym wierszem

W Ruby są różne rodzaje komentarzy. Jednak najbardziej podstawowy jest komentarz w jednym wierszu.

Zaczyna się od symbolu funta (#) i trwa do końca linii.

# Ruby Single Line Comment
Drukuj "Hello From Ruby!"

Jak widać w powyższym przykładzie, komentarz pojedynczego linii zaczyna się od symbolu funta i rozciąga się na koniec linii.

Ruby Interpreter ignoruje tekst wewnątrz komentarza w pojedynczym wierszu, nawet jeśli niesie prawidłowy kod Ruby.

Komentarz z pojedynczym wierszem w Ruby może rozpocząć się na początku linii lub na końcu, jak pokazano poniżej:

Drukuj "Hello From Ruby!„ # Ruby Single Line Comment

W takim przypadku treść przed znakiem funta (#) jest uznawana za prawidłowy kod rubinowy, podczas gdy treść nie jest.

Komentarze blokowe/wiele linii

W innych przypadkach musisz opisać, co robi kod w bardziej szczegółowy sposób. Aby dołączyć komentarze, które obejmują wiele wierszy w Ruby, wdrażamy komentarze blokowe.

Istnieją dwa sposoby wdrożenia komentarzy blokowych w Ruby:

1: = początek/= koniec

Ta metoda używa formatu = początkowa i = końcowego, aby zawierać linie wewnątrz bloku jako komentarze.

Oto przykład:

= Rozpocznij
To jest komentarz
który obejmuje wiele linii
i jest bardzo przydatny do szczegółowej dokumentacji
= koniec
wydrukuj „Cześć blokowi komentarze!"

W tego rodzaju komentarzu zaczynamy od użycia słowa kluczowego = początek, a następnie wszystkie wiersze, o których chcemy skomentować i zamknąć za pomocą = end.

Wykorzystanie tego formatu komentarza jest rzadkie, ponieważ nie oferuje dużej elastyczności w formatowaniu komentarzy i jest bardzo nieczytelne.

2: Symbole o wielu funtach (#)

Najczęstszym sposobem komentowania wielu wierszy w Ruby jest wstępne zastosowanie każdej linii za pomocą znaku funta.

Oto przykład:

# To jest kolejna metoda komentarza
# to obejmuje wiele linii
# i jest to bardzo przydatne do szczegółowej dokumentacji

W takim przypadku skomentowano wiele wierszy. Korzystając z nowoczesnych redaktorów, możesz wyróżnić blok kodu i skomentować go od razu.

Komentarze i magiczne komentarze

Ruby to interesujący język, ponieważ oferuje magiczne komentarze. Magiczne komentarze przyjmują format podobny do zwykłych komentarzy, ale zamiast być ignorowanym przez tłumacza, zmieniają zachowanie tłumacza.

Magiczne komentarze zawierają dyrektywy rubinowe, które określają, co zmodyfikować na temat interpretera.

Poniższy przykład pokazuje magiczny komentarz do zmodyfikowania kodowania literałów smyczkowych.

# kodowanie: UTF-8

Chociaż powyższe wygląda podobnie do zwykłego komentarza, zawiera uznaną za rubinową dyrektywę.

Aby dowiedzieć się więcej o magicznych dyrektywach komentarzy, rozważ dokumentację Ruby Comments.

Streszczenie

W tym szybkim przewodniku omówiono różne rodzaje komentarzy rubinowych, w tym sposób ich wdrożenia.