Opmerkingen gebruiken in Ruby

Opmerkingen in uw Ruby-code zijn opmerkingen en annotaties die bedoeld zijn om door andere programmeurs te worden gelezen. De opmerkingen zelf worden genegeerd door de Ruby-interpreter, dus de tekst in de opmerkingen is niet aan beperkingen onderhevig.

Het is meestal een goede vorm om opmerkingen vóór klassen en methoden te plaatsen, evenals elk stuk code dat complex of onduidelijk kan zijn.

Opmerkingen effectief gebruiken

Opmerkingen moeten worden gebruikt om achtergrondinformatie te geven of moeilijke code te annoteren. Notities die eenvoudig zeggen wat de volgende regel van eenvoudige code doet, zijn niet alleen duidelijk, maar voegen ook rommel toe aan het bestand.

Het is belangrijk om ervoor te zorgen dat je niet teveel opmerkingen gebruikt en dat de opmerkingen in het bestand zinvol en nuttig zijn voor andere programmeurs.

De Shebang

U zult merken dat alle Ruby-programma's beginnen met een opmerking die begint met #!. Dit wordt een genoemd keet en wordt gebruikt op Linux-, Unix- en OS X-systemen.

Wanneer u een Ruby-script uitvoert, zoekt de shell (zoals bash op Linux of OS X) naar een shebang op de eerste regel van het bestand. De shell gebruikt vervolgens de shebang om de Ruby-interpreter te vinden en het script uit te voeren.

De geprefereerde Ruby shebang is #! / usr / bin / env ruby, hoewel je misschien ook ziet #! / Usr / bin / ruby of #! / Usr / local / bin / ruby.

Enkele regel opmerkingen

De opmerking van Ruby met één regel begint met de # teken en eindigt aan het einde van de regel. Alle tekens uit de # teken tot het einde van de regel worden volledig genegeerd door de Ruby-interpreter.

De # karakter hoeft niet noodzakelijkerwijs aan het begin van de regel te voorkomen; het kan overal voorkomen.

Het volgende voorbeeld illustreert een paar gebruik van opmerkingen.

 #! / usr / bin / env ruby

 # Deze regel wordt genegeerd door de Ruby-tolk

 # Deze methode drukt de som van zijn argumenten af

 def som (a, b)

   zet een + b

 einde

 som (10,20) # Druk de som van 10 en 20 af 

Opmerkingen over meerdere regels

Hoewel vaak vergeten door veel Ruby-programmeurs, heeft Ruby wel opmerkingen met meerdere regels. Een opmerking met meerdere regels begint met de = beginnen token en eindigt met de = end blijk.

Deze tokens moeten beginnen aan het begin van de regel en het enige op de regel zijn. Alles tussen deze twee tokens wordt genegeerd door de Ruby-tolk.

 #! / usr / bin / env ruby

 = beginnen

 Tussen = begin en = einde, elk getal

 lijnen kunnen worden geschreven. Al deze

 lijnen worden genegeerd door de Ruby-interpreter.

 = end

 zet "Hallo wereld!"

In dit voorbeeld zou de code worden uitgevoerd als Hallo Wereld!