wat zijn opmerkingen in Ruby?
een Ruby-commentaar voegt informatie toe aan uw code die nuttig kan zijn voor u of andere ontwikkelaars.
het meest voorkomende type commentaar is het commentaar met één regel.
hier is de syntaxis:
# I like apples & oranges
let op drie dingen:
- het commentaar begint met een Pond (
#) symbool - we zetten een spatie tussen de inhoud van het commentaar & het begin van het commentaar om het gemakkelijker te maken om
- te lezen alles in het commentaar wordt niet geïnterpreteerd als code, zelfs als het eruit ziet als code. Dit betekent dat u tijdelijk commentaar uit code om het uit te schakelen.
u kunt deze opmerkingen gebruiken op hun eigen, of inline, aan het einde van een regel code.
.size # get array size
zijn er andere opmerkingen?
Ja, Er zijn magische opmerkingen, multiline-opmerkingen & ERB-opmerkingen.
laten we die onderzoeken!
Hoe gebruik je meerregelige commentaren in Ruby
in Ruby doen we meerregelige commentaren met regelmatige, éénregelige commentaren.
sommige mensen noemen dit “blokcommentaren”.
hier is een voorbeeld:
# aaa# bbb# ccc
dat is precies hoe je een blok code in ruby moet becommentariëren.
moderne code-editors staan u toe om een blok code & commentaar te selecteren met behulp van een sneltoets, zodat er geen extra inspanning nodig is.
maar er is een speciale multiline commentaar syntaxis.
het ziet er zo uit:
=beginThis is a comment...abc=end
niemand gebruikt deze syntaxis…
het is lelijk & je kunt het zelfs niet gebruiken in iets dat is ingesprongen (zoals een methode), maar het is goed om te weten dat het bestaat als je het ooit in het wild vindt.
SheBang Comments
een shebang (#!) is een speciaal soort commentaar dat een Unix shell (zoals bash) vertelt hoe dit bestand te interpreteren.
als u deze opmerking bovenaan uw bestand toevoegt …
dan kunt u uw Ruby-bestanden als uitvoerbare bestanden uitvoeren, ervan uitgaande dat ze de juiste rechten hebben om dat te doen.
hier is hoe een shebang commentaar eruit ziet:
#!/usr/bin/env ruby
Hiermee kunt u ook specifieke opdrachtregelopties instellen, zoals de waarschuwingsoptie.
voorbeeld:
#!/usr/bin/env ruby -w
elke keer dat u deze code uitvoert, wordt deze uitgevoerd met deze opties, zodat u ze niet handmatig hoeft door te geven.
Hoe gebruik je magische opmerkingen
een magische opmerking verandert het gedrag van de Ruby interpreter op een bepaalde manier.
bijvoorbeeld:
het frozen_string_literals commentaar zal uw strings standaard bevroren maken.
het ziet er zo uit:
# frozen_string_literal: true
met een andere magische opmerking kunt u de codering van het bestand wijzigen.
hier is een voorbeeld:
# encoding: utf-8
A here ‘ s an interesting one, The warn_indent comment:
# warn_indent: true
dit zal een waarschuwing tonen wanneer uw inspringen verkeerd is.
voorbeeld:
def comments end
wat resulteert in:
warning: mismatched indentations at 'end' with 'def' at 3
Erb Comments
Als u ERB gebruikt voor uw Rails weergaven & moet u een commentaar toevoegen …
dan kunt u deze syntaxis gebruiken:
ik ben hier geen grote fan van, omdat ik vind dat je het grootste deel van je logica uit je standpunten moet houden, dus je hebt geen commentaar nodig.
wilt u enige code voor debuggen uitschakelen?
verwijder dan die code & vertrouw git, of welk versiebeheersysteem je ook gebruikt.
samenvatting
