Mitä ovat Kommentit Rubyssa?
Ruby-kommentti Lisää koodiisi tietoa, josta voi olla hyötyä sinulle tai muille kehittäjille.
yleisin kommentointityyppi on yksirivinen kommentti.
tässä syntaksi:
# I like apples & oranges
huomaa kolme asiaa:
- kommentti alkaa paunan (
#) symbolilla - laitamme kommentin sisällön väliin välilyönnin & kommentin alun, jotta on helpompi lukea
- kaikkea kommentin sisällä ei tulkita koodiksi, vaikka se näyttäisi koodilta. Tämä tarkoittaa, että voit väliaikaisesti kommentoida koodia poistaa sen käytöstä.
voit käyttää näitä kommentteja sellaisenaan tai inline-muodossa koodirivin lopussa.
.size # get array size
onko muunlaisia kommentteja?
kyllä on taikakommentteja, monivivahteisia kommentteja & ERB: n kommentteja.
tutkitaan niitä!
Kuinka käyttää monirivisiä kommentteja Rubyssa
Rubyssa tehdään monirivisiä kommentteja säännöllisillä, yksirivisillä kommenteilla.
jotkut kutsuvat näitä ”lohkokommenteiksi”.
tässä esimerkki:
# aaa# bbb# ccc
juuri noin kommentoidaan koodilohkoa Rubyssa.
moderneissa koodieditoreissa voit valita koodin & kommentin kokonaan käyttämällä pikanäppäintä, joten siihen ei liity ylimääräistä vaivaa.
, mutta on olemassa erityinen monirivinen kommentointisyntaksi.
se näyttää tältä:
=beginThis is a comment...abc=end
kukaan ei käytä tätä syntaksia …
It ’s ugly & you can’ t even use it inside any that ’ s indented (like a method), but its good to know it exist if you ever find it in the wild.
SheBang Comments
a shebang (#!) on erikoinen kommentti, joka kertoo Unix-komentotulkille (kuten bashille), miten tämä tiedosto tulkitaan.
kun lisäät tämän kommentin tiedostosi yläreunaan …
voit suorittaa Ruby-tiedostosi suoritettavina tiedostoina olettaen, että niillä on siihen tarvittavat oikeudet.
tältä näyttää kohukommentti:
#!/usr/bin/env ruby
tämä mahdollistaa myös tiettyjen komentorivivalintojen, kuten varoitusvalinnan, asettamisen.
esimerkki:
#!/usr/bin/env ruby -w
joka kerta, kun käytät tätä koodia, se toimii näillä vaihtoehdoilla, joten sinun ei tarvitse syöttää niitä manuaalisesti.
miten Taikakommentteja käytetään
taikakommentti muuttaa Rubiinitulkin käyttäytymistä jollain tavalla.
esimerkiksi:
frozen_string_literals kommentti saa merkkijonosi jähmettymään oletusarvoisesti.
se näyttää tältä:
# frozen_string_literal: true
toisen taikakommentin avulla voit muuttaa tiedoston koodausta.
tässä esimerkki:
# encoding: utf-8
tässä on mielenkiintoinen, warn_indent kommentti:
# warn_indent: true
tämä näyttää varoituksen, kun sisennyksesi on väärä.
esimerkki:
def comments end
joka johtaa:
warning: mismatched indentations at 'end' with 'def' at 3
ERB: n Kommentit
jos käytät ERB: tä Rails-näkymiin & sinun on lisättävä kommentti …
voit käyttää tätä syntaksia:
en ole tämän suuri fani, koska mielestäni sinun pitäisi pitää suurin osa logiikastasi poissa näkemyksistäsi, joten sinun ei pitäisi tarvita kommentteja.
looking to disable some code for debugging?
poista sitten kyseinen koodi & luota gitiin tai mihin tahansa käyttämääsi versionhallintajärjestelmään.
Yhteenveto
