vad är kommentarer i Ruby?
en Ruby-kommentar lägger till information i din kod som kan vara till hjälp för dig eller andra utvecklare.
den vanligaste typen av kommentar är enradig kommentar.
här är syntaxen:
# I like apples & oranges
Lägg märke till tre saker:
- kommentaren börjar med ett pund (
#) symbol - vi lägger ett mellanslag mellan innehållet i kommentaren & början på kommentaren för att göra det lättare att läsa
- allt i kommentaren tolkas inte som kod, även om det ser ut som kod. Det betyder att du tillfälligt kan kommentera koden för att inaktivera den.
du kan använda dessa kommentarer på egen hand, eller inline, i slutet av en rad kod.
.size # get array size
finns det andra typer av kommentarer?
Ja, det finns magiska kommentarer, multiline kommentarer & ERB kommentarer.
låt oss utforska dem!
hur man använder flerradiga kommentarer i Ruby
i Ruby gör vi flerradiga kommentarer med vanliga kommentarer på en rad.
vissa människor kallar dessa”blockera kommentarer”.
här är ett exempel:
# aaa# bbb# ccc
det är exakt hur man kommenterar ett kodblock i ruby.
moderna kodredigerare låter dig välja ett kodblock & kommentera allt med en kortkommando, så det finns ingen extra ansträngning.
men det finns en speciell multiline kommentar syntax.
det ser ut så här:
=beginThis is a comment...abc=end
ingen använder den här syntaxen …
det är fult & du kan inte ens använda den inuti något som är indraget (som en metod), men det är bra att veta att det finns om du någonsin hittar det i naturen.
SheBang kommentarer
en shebang (#!) är en speciell typ av kommentar som berättar ett Unix-skal (som bash) hur man tolkar den här filen.
när du lägger till den här kommentaren högst upp i din fil…
kan du köra dina Ruby-filer som körbara filer, förutsatt att de har rätt behörighet att göra det.
här är vad en shebang kommentar ser ut:
#!/usr/bin/env ruby
detta låter dig också ställa in specifika kommandoradsalternativ, som varningsalternativet.
exempel:
#!/usr/bin/env ruby -w
varje gång du kör den här koden kommer den att köras med dessa alternativ, så du behöver inte skicka dem manuellt.
hur man använder magiska kommentarer
en magisk kommentar ändrar Ruby-tolkens beteende på något sätt.
till exempel:
kommentaren frozen_string_literals kommer att göra dina strängar frysta som standard.
det ser ut så här:
# frozen_string_literal: true
en annan magisk kommentar låter dig ändra filens kodning.
här är ett exempel:
# encoding: utf-8
en här är en intressant, warn_indent kommentar:
# warn_indent: true
detta kommer att visa en varning när din indrag är fel.
exempel:
def comments end
vilket resulterar i:
warning: mismatched indentations at 'end' with 'def' at 3
ERB kommentarer
om du använder ERB för dina Rails visningar & du måste lägga till en kommentar …
då kan du använda denna syntax:
jag är inte ett stort fan av detta eftersom jag tror att du borde hålla det mesta av din logik ur dina åsikter så att du inte behöver några kommentarer.
vill du inaktivera någon kod för felsökning?
ta sedan bort den koden & lita på git, eller vilket versionshanteringssystem du använder.
sammanfattning
