Hvad er kommentarer i Ruby?
en Ruby-kommentar tilføjer oplysninger til din kode, der kan være nyttige for dig eller andre udviklere.
den mest almindelige type kommentar er enkeltlinjekommentaren.
her er syntaksen:
# I like apples & oranges
Bemærk tre ting:
- kommentaren starter med et pund (
#) symbol - vi sætter et mellemrum mellem indholdet af kommentaren& starten af kommentaren for at gøre det lettere at læse
- alt inde i kommentaren fortolkes ikke som kode, selvom det ligner kode. Dette betyder, at du midlertidigt kan kommentere kode for at deaktivere den.
du kan bruge disse kommentarer alene eller inline i slutningen af en kodelinje.
.size # get array size
er der andre slags kommentarer?
ja, der er magiske kommentarer, multiline kommentarer & ERB kommentarer.
lad os udforske dem!
Sådan bruges kommentarer med flere linjer i Ruby
i Ruby laver vi kommentarer med flere linjer med regelmæssige kommentarer med en linje.
nogle mennesker kalder disse “blokkommentarer”.
her er et eksempel:
# aaa# bbb# ccc
det er præcis, hvordan man kommenterer en blok kode i ruby.
moderne kodeditorer giver dig mulighed for at vælge en blok kode & kommenter det hele ved hjælp af en tastaturgenvej, så der er ingen ekstra indsats involveret.
men der er en særlig multiline kommentar syntaks.
det ser sådan ud:
=beginThis is a comment...abc=end
ingen bruger denne syntaks…
det er grimt & du kan ikke engang bruge det inde i noget, der er indrykket (som en metode), men det er godt at vide, at det eksisterer, hvis du nogensinde finder det i naturen.
SheBang Kommentarer
en shebang (#!) er en speciel slags kommentar, der fortæller en unik shell (som bash), hvordan man fortolker denne fil.
når du tilføjer denne kommentar øverst i din fil…
kan du køre dine Ruby-filer som eksekverbare filer, forudsat at de har de rigtige tilladelser til at gøre det.
Sådan ser en shebang-kommentar ud:
#!/usr/bin/env ruby
dette giver dig også mulighed for at indstille specifikke kommandolinjeindstillinger, f.eks.
eksempel:
#!/usr/bin/env ruby -w
hver gang du kører denne kode, kører den med disse indstillinger, så du ikke behøver at videregive dem manuelt.
Sådan bruges magiske Kommentarer
en magisk kommentar ændrer Ruby-tolkens opførsel på en eller anden måde.
for eksempel:
frozen_string_literals kommentaren vil gøre dine strenge frosne som standard.
det ser sådan ud:
# frozen_string_literal: true
en anden magisk kommentar giver dig mulighed for at ændre filens kodning.
her er et eksempel:
# encoding: utf-8
en her er en interessant, den advarsel:
# warn_indent: true
Dette viser en advarsel, når din indrykning er forkert.
eksempel:
def comments end
hvilket resulterer i:
warning: mismatched indentations at 'end' with 'def' at 3
Erb Kommentarer
hvis du bruger Erb til dine Rails visninger & du skal tilføje en kommentar…
så kan du bruge denne syntaks:
jeg er ikke en stor fan af dette, fordi jeg mener, at du skal holde det meste af din logik ude af dine synspunkter, så du ikke behøver nogen kommentarer.
Ønsker du at deaktivere nogle kode til debugging?
slet derefter koden & stol på git, eller hvilket versionsstyringssystem du bruger.
sammendrag
