Komentarze w twoim Rubin Kod to notatki i adnotacje przeznaczone do odczytania przez innych programistów. Same komentarze są ignorowane przez interpreter języka Ruby, więc tekst wewnątrz komentarzy nie podlega żadnym ograniczeniom.
Zazwyczaj dobrym sposobem jest umieszczanie komentarzy przed klasami i metodami, a także każdego fragmentu kodu, który może być złożony lub niejasny.
Efektywne korzystanie z komentarzy
Komentarze powinny być używane w celu dostarczenia podstawowych informacji lub opisania trudnego kodu. Notatki, które po prostu mówią, co robi następny wiersz prostego kodu, są nie tylko oczywiste, ale także dodają bałaganu do pliku.
Ważne jest, aby uważać, aby nie używać zbyt wielu komentarzy i upewnić się, że komentarze w pliku są znaczące i pomocne dla innych programistów.
The Shebang
Zauważysz, że wszystkie programy Ruby zaczynają się od komentarza, który zaczyna się od #!. To się nazywa szulernia i jest używany w systemach Linux, Unix i OS X.
Podczas wykonywania skryptu Ruby powłoka (np. Bash w systemie Linux lub OS X) będzie szukała shebang w pierwszej linii pliku. Powłoka użyje wtedy shebang, aby znaleźć interpreter Ruby i uruchomić skrypt.
Preferowanym shebang Ruby #! / usr / bin / env ruby, chociaż możesz także zobaczyć #! / usr / bin / ruby lub #! / usr / local / bin / ruby.
Komentarze jednowierszowe
Rubinowy komentarz jednowierszowy zaczyna się od # znak i kończy się na końcu linii. Wszelkie postacie z # Znak na końcu linii jest całkowicie ignorowany przez interpreter Ruby.
The # znak niekoniecznie musi występować na początku linii; może wystąpić wszędzie.
Poniższy przykład ilustruje kilka zastosowań komentarzy.
#! / usr / bin / env ruby
# Ta linia jest ignorowana przez interpretera Ruby
# Ta metoda wypisuje sumę argumentów
def suma (a, b)
stawia a + b
koniec
sum (10,20) # Wydrukuj sumę 10 i 20
Komentarze wieloliniowe
Choć często zapominany przez wielu programistów Ruby, Ruby ma komentarze wieloliniowe. Komentarz wielowierszowy zaczyna się od = początek token i kończy się na = koniec znak.
Te tokeny powinny zaczynać się na początku linii i być jedyną rzeczą na linii. Wszystko pomiędzy tymi dwoma tokenami jest ignorowane przez interpretera Ruby.
#! / usr / bin / env ruby
= początek
Pomiędzy = początek i = koniec dowolna liczba
wierszy mogą być zapisane. Wszystkie te
wiersze są ignorowane przez interpreter Ruby.
= koniec
wstawia „Witaj świecie!”
W tym przykładzie kod zostałby wykonany jako Witaj świecie!