czym są komentarze w Ruby?
komentarz Ruby dodaje do kodu informacje, które mogą być pomocne dla Ciebie lub innych programistów.
najczęstszym rodzajem komentarza jest komentarz jednoliniowy.
oto składnia:
# I like apples & oranges
zauważ trzy rzeczy:
- komentarz zaczyna się od funta (
#) symbolu - umieszczamy spację między treścią komentarza & początek komentarza, aby ułatwić czytanie
- wszystko wewnątrz komentarza nie jest interpretowane jako kod, nawet jeśli wygląda jak kod. Oznacza to, że możesz tymczasowo komentować kod, aby go wyłączyć.
możesz używać tych komentarzy samodzielnie lub w wierszu, na końcu linii kodu.
.size # get array size
czy są inne rodzaje komentarzy?
tak, są magiczne Komentarze, Komentarze Wielowierszowe & komentarze ERB.
poznajmy je!
jak używać komentarzy wielowierszowych w Rubim
w Rubim wykonujemy komentarze Wielowierszowe ze zwykłymi, jednowierszowymi komentarzami.
niektórzy nazywają to „komentarzami blokującymi”.
oto przykład:
# aaa# bbb# ccc
dokładnie tak skomentować blok kodu w ruby.
nowoczesne edytory kodu pozwalają wybrać Blok kodu & komentować go za pomocą skrótu klawiaturowego, więc nie ma dodatkowego wysiłku.
ale jest specjalna składnia komentarzy wielowierszowych.
wygląda tak:
=beginThis is a comment...abc=end
nikt nie używa tej składni…
jest brzydki & nie możesz nawet użyć go wewnątrz niczego, co jest wcięte (jak metoda), ale dobrze wiedzieć, że istnieje, jeśli kiedykolwiek znajdziesz go w dziczy.
komentarze do Shebangu
shebang (#!) jest specjalnym rodzajem komentarza, który mówi powłoce uniksowej (takiej jak bash), jak zinterpretować ten plik.
kiedy dodasz ten komentarz u góry pliku …
będziesz mógł uruchamiać swoje pliki Ruby jako pliki wykonywalne, zakładając, że mają do tego odpowiednie uprawnienia.
oto jak wygląda komentarz shebang:
#!/usr/bin/env ruby
umożliwia to również ustawienie określonych opcji wiersza poleceń, takich jak opcja Ostrzeżenia.
przykład:
#!/usr/bin/env ruby -w
za każdym razem, gdy uruchamiasz ten kod, będzie on uruchamiany z tymi opcjami, więc nie musisz ich przekazywać ręcznie.
jak używać magicznych komentarzy
magiczny komentarz zmienia w jakiś sposób zachowanie interpretera Ruby.
na przykład:
komentarz frozen_string_literals spowoduje, że Twoje ciągi zostaną domyślnie zamrożone.
wygląda tak:
# frozen_string_literal: true
kolejny magiczny komentarz pozwala zmienić kodowanie pliku.
oto przykład:
# encoding: utf-8
a tu ciekawy komentarz warn_indent:
# warn_indent: true
to pokaże ostrzeżenie, gdy twoje wcięcia są błędne.
przykład:
def comments end
co skutkuje:
warning: mismatched indentations at 'end' with 'def' at 3
komentarze ERB
jeśli używasz ERB dla swoich widoków Rails & musisz dodać komentarz…
wtedy możesz użyć tej składni:
nie jestem tego wielkim fanem, bo uważam, że powinieneś trzymać większość swojej logiki z dala od swoich poglądów, więc nie powinieneś potrzebować żadnych komentarzy.
chcesz wyłączyć kod do debugowania?
następnie usuń ten kod & zaufaj gitowi lub dowolnemu systemowi kontroli wersji, którego używasz.
podsumowanie
