5 Typer Ruby Kommentarer Og Hvordan Du Bruker Dem Riktig

Hva er kommentarer I Ruby?

En Ruby-kommentar legger til informasjon i koden din som kan være nyttig for deg eller andre utviklere.

den vanligste typen kommentar er enkeltlinjekommentaren.

her er syntaksen:

# I like apples & oranges

Legg merke til tre ting:

  1. kommentaren starter med et pund (#) symbol
  2. vi legger et mellomrom mellom innholdet i kommentaren & starten på kommentaren for å gjøre det lettere å lese
  3. Alt inne i kommentaren tolkes ikke som kode, Selv om det ser ut som kode. Dette betyr at du midlertidig kan kommentere kode for å deaktivere den.

du kan bruke disse kommentarene på egen hånd, eller inline, på slutten av en linje med kode.

.size # get array size

Finnes det andre typer kommentarer?

Ja, det er magiske kommentarer, multiline kommentarer & ERB kommentarer.

la oss utforske dem!

Slik Bruker Du Flere Linjekommentarer I Ruby

I Ruby gjør vi flere linjekommentarer med vanlige, enkeltlinjekommentarer.

noen kaller disse «block kommentarer».

her er et eksempel:

# aaa# bbb# ccc

Det er akkurat slik å kommentere en blokk med kode i ruby.

Moderne kodeditorer lar deg velge en blokk med kode & kommentere alt ved hjelp av en hurtigtast, så det er ingen ekstra innsats involvert.

Men det er en spesiell multiline kommentar syntaks.

Det ser slik ut:

=beginThis is a comment...abc=end

ingen bruker denne syntaksen…

det er stygt & du kan ikke engang bruke den inne i noe som er innrykket (som en metode), men det er godt å vite at det eksisterer hvis du noen gang finner det i naturen.

SheBang Kommentarer

en shebang (#! ) er en spesiell type kommentar som forteller Et Unix-skall (som bash) hvordan man tolker denne filen.

når du legger til denne kommentaren øverst i filen…

Vil Du kunne kjøre Ruby-filene dine som kjørbare filer, forutsatt at De har de riktige tillatelsene til å gjøre det.

her er hva en shebang kommentar ser ut som:

#!/usr/bin/env ruby

Dette lar deg også angi bestemte kommandolinjealternativer, som advarselsalternativet.

Eksempel:

#!/usr/bin/env ruby -w

Hver gang du kjører denne koden, vil den kjøre med disse alternativene, slik at du ikke trenger å sende dem inn manuelt.

Hvordan Bruke Magiske Kommentarer

en magisk kommentar endrer Oppførselen Til Ruby tolk på noen måte.

for eksempel:

frozen_string_literals kommentaren vil gjøre strengene frosset som standard.

Det ser slik ut:

# frozen_string_literal: true

En annen magisk kommentar lar deg endre filens koding.

her er et eksempel:

# encoding: utf-8

A her er en interessant en, warn_indent kommentaren:

# warn_indent: true

dette vil vise en advarsel når innrykket ditt er feil.

Eksempel:

def comments end

som resulterer i:

warning: mismatched indentations at 'end' with 'def' at 3

Erb Kommentarer

hvis du bruker Erb For Rails visninger & du må legge til en kommentar…

så kan du bruke denne syntaksen:


jeg er ikke en stor fan av dette fordi jeg tror du bør holde det meste av logikken din ute av dine synspunkter, slik at du ikke trenger noen kommentarer.

Ønsker du å deaktivere noen kode for feilsøking?

slett deretter koden & stol på git, eller hvilket versjonskontrollsystem du bruker.

Sammendrag



+