mik a Megjegyzések Ruby?
a Ruby megjegyzés olyan információkat ad a kódhoz, amelyek hasznosak lehetnek Önnek vagy más fejlesztőknek.
a leggyakoribb megjegyzéstípus az egysoros megjegyzés.
itt van a szintaxis:
# I like apples & oranges
három dolgot figyeljünk meg:
- a megjegyzés egy font (
#) szimbólummal kezdődik - szóközt helyezünk a megjegyzés tartalma közé & a megjegyzés kezdete, hogy könnyebben olvasható legyen
- a megjegyzésben mindent nem értelmeznek kódként, még akkor sem, ha kódnak tűnik. Ez azt jelenti, hogy ideiglenesen megjegyzést ki kódot, hogy tiltsa le.
használhatja ezeket a megjegyzéseket a saját, vagy inline, a végén egy sor kódot.
.size # get array size
vannak más típusú megjegyzések?
Igen, vannak mágikus megjegyzések, többsoros megjegyzések & ERB megjegyzések.
fedezzük fel azokat!
hogyan kell használni a többsoros megjegyzéseket Ruby-ban
Ruby-ban többsoros megjegyzéseket készítünk rendszeres, egysoros megjegyzésekkel.
egyesek ezeket “megjegyzések blokkolásának”hívják.
Íme egy példa:
# aaa# bbb# ccc
pontosan így kell kommentálni egy kódblokkot ruby-ban.
a Modern kódszerkesztők lehetővé teszik, hogy kiválasszon egy kódblokkot & kommentálja az egészet egy billentyűparancs segítségével, így nincs extra erőfeszítés.
de van egy speciális többsoros megjegyzés szintaxis.
így néz ki:
=beginThis is a comment...abc=end
senki sem használja ezt a szintaxist…
ez csúnya & nem is használhatja benne semmit, ami behúzott (mint egy módszer), de jó tudni, hogy létezik, ha valaha is megtalálja a vadonban.
SheBang Comments
a shebang (#!) egy speciális fajta megjegyzést, hogy megmondja a Unix shell (mint bash), hogyan kell értelmezni ezt a fájlt.
amikor hozzáadja ezt a megjegyzést a fájl tetejére…
futtatható fájlként futtathatja a Ruby fájlokat, feltéve, hogy megfelelő jogosultságokkal rendelkeznek erre.
így néz ki egy shebang megjegyzés:
#!/usr/bin/env ruby
ez lehetővé teszi konkrét parancssori opciók, például a figyelmeztetés beállítását is.
példa:
#!/usr/bin/env ruby -w
minden alkalommal, amikor ezt a kódot futtatja, ezekkel az opciókkal fog futni, így nem kell manuálisan átadnia őket.
hogyan kell használni a mágikus megjegyzéseket
a mágikus megjegyzés valamilyen módon megváltoztatja a Ruby tolmács viselkedését.
például:
a frozen_string_literals megjegyzés alapértelmezés szerint lefagyasztja a karakterláncokat.
így néz ki:
# frozen_string_literal: true
egy másik mágikus Megjegyzés lehetővé teszi a fájl kódolásának megváltoztatását.
Íme egy példa:
# encoding: utf-8
A itt egy érdekes, a warn_indent megjegyzés:
# warn_indent: true
ez figyelmeztetést jelenít meg, ha a behúzás helytelen.
példa:
def comments end
ami azt eredményezi, hogy:
warning: mismatched indentations at 'end' with 'def' at 3
Erb Megjegyzések
ha Erb-t használ a Rails nézeteihez & hozzá kell adnia egy megjegyzést…
akkor használhatja ezt a szintaxist:
nem vagyok nagy rajongója ennek, mert azt hiszem, meg kell tartani a legtöbb a logika ki a véleményét, így nem kell semmilyen megjegyzést.
szeretné letiltani néhány kódot a hibakereséshez?
ezután törölje ezt a kódot & trust git, vagy bármilyen verziókezelő rendszert használ.
összefoglaló
