Använda kommentarer i Ruby

Kommentarer i din Ruby-kod är anteckningar och kommentarer som är avsedda att läsas av andra programmerare. Kommentarerna ignoreras av Ruby-tolkaren, så texten i kommentarerna omfattas inte av några begränsningar.

Det är vanligtvis bra form att lägga kommentarer inför klasser och metoder samt alla kod som kan vara komplexa eller oklara.

Använda kommentarer effektivt

Kommentarer ska användas för att ge bakgrundsinformation eller kommentera svår kod. Noterar som helt enkelt säger vad nästa rad med enkel kod gör inte bara uppenbart utan också lägger till röran i filen.

Det är viktigt att se till att inte använda för många kommentarer och att se till att kommentarerna i filen är meningsfulla och användbara för andra programmerare.

Shebang

Du kommer att märka att alla Ruby-program börjar med en kommentar som börjar med #!. Detta kallas a shebang och används på Linux-, Unix- och OS X-system.

När du kör ett Ruby-skript letar skalet (som bash på Linux eller OS X) efter en shebang vid den första raden i filen. Skalet kommer sedan att använda shebang för att hitta Ruby-tolkaren och köra skriptet.

Den föredragna Ruby shebang är #! / usr / bin / env ruby, även om du kanske också ser #! / Usr / bin / ruby eller #! / Usr / local / bin / ruby.

Enlinjekommentarer

Ruby-enlinjekommentaren börjar med # karaktär och slutar i slutet av raden. Alla tecken från # karaktär till slutet av raden ignoreras helt av Ruby-tolkaren.

De # karaktär behöver inte nödvändigtvis inträffa i början av raden; det kan förekomma var som helst.

Följande exempel illustrerar några användningsområden för kommentarer.

 #! / usr / bin / env ruby

 # Den här linjen ignoreras av Ruby-tolkaren

 # Den här metoden skriver ut summan av sina argument

 def summa (a, b)

   sätter a + b

 slutet

 summa (10,20) # Skriv ut summan 10 och 20 

Kommentarer med flera linjer

Även om många ofta har glömts av många Ruby-programmerare, har Ruby kommentarer på flera linjer. En kommentar med flera linjer börjar med = börja token och slutar med = änden tecken.

Dessa token bör börja i början av raden och vara det enda på linjen. Allt mellan dessa två symboler ignoreras av Ruby-tolkaren.

 #! / usr / bin / env ruby

 = börja

 Mellan = börja och = slut, valfritt antal

 av rader kan skrivas. Alla dessa

 linjer ignoreras av Ruby-tolkaren.

 = änden

 säger "Hej värld!"

I det här exemplet körs koden som Hej världen!