Megjegyzések a Ruby-kódhoz (használati, egy- és többsoros)

Megjegyzések a Rubin A kód olyan megjegyzések és kommentárok, amelyeket más programozók elolvasnak. A Ruby tolmács figyelmen kívül hagyja magukat a megjegyzéseket, tehát a megjegyzésekben szereplő szövegre nincs korlátozás.

Általában jó az észrevételek megfogalmazása osztályok és módszerek előtt, valamint bármilyen kóddarab, amely összetett vagy nem egyértelmű.

A megjegyzések hatékony használata

A megjegyzéseket háttérinformációk megadására vagy a bonyolult kódok kommentálására kell használni. Megjegyzi, hogy egyszerűen csak azt mondják, hogy az egyszerű kód következő sora nem csak nyilvánvaló, hanem a rendetlenséget is növeli a fájlban.

Fontos, hogy ügyeljen arra, hogy ne használjon túl sok hozzászólást, és győződjön meg arról, hogy a fájlban szereplő megjegyzések értelmesek és hasznosak más programozók számára.

A Shebang

Észre fogja venni, hogy minden Ruby program egy hozzászólással kezdődik, amely kezdődik #!. Ezt hívják a ügy és Linux, Unix és OS X rendszereken használják.

A Ruby parancsfájl végrehajtásakor a shell (például bash Linuxon vagy OS X-en) shebang-t fog keresni a fájl első sorában. A shell ezután a shebang segítségével megtalálja a Ruby tolmácsot és futtatja a szkriptet.

instagram viewer

Az előnyben részesített Ruby shebang a #! / usr / bin / env rubin, bár Ön is láthatja #! / Usr / bin / rubin vagy #! / Usr / local / bin / rubin.

Egysoros megjegyzések

A Ruby egysoros megjegyzés a következővel kezdődik: # karakter és a sor végén ér véget. Bármely karakter a # A sor végéig tartó karaktert a Ruby tolmács teljesen figyelmen kívül hagyja.

Az # a karakternek nem feltétlenül kell a sor elején megjelennie; bárhol előfordulhat.

A következő példa a megjegyzések néhány felhasználását szemlélteti.

 #! / usr / bin / env rubin


 # Ezt a sort a Ruby tolmács figyelmen kívül hagyja


 # Ez a módszer kinyomtatja az argumentumok összegét

 def összeg (a, b)

 egy + b-t tesz

 vég


 sum (10,20) # Nyomtassa ki a 10 és 20 összeget 

Több soros megjegyzés

Noha sok Ruby programozó gyakran elfelejtette, a Rubynak több sorban van megjegyzése. A többsoros megjegyzés a következővel kezdődik: = kezdődik token, és a karakterrel végződik = end jelképes.

Ezeknek a tokeneknek a sor elején kell kezdődniük, és a sorban az egyetlen dolog. A Ruby tolmács figyelmen kívül hagyja a két token közötti bármit.

 #! / usr / bin / env rubin


 = kezdődik

 = Kezdés és vége között, bármely szám

 sorok írhatók. Ebből mind

 a sorokat a Ruby tolmács figyelmen kívül hagyja.

 = end


 "Hello világ!"

Ebben a példában a kód végrehajtása as Helló Világ!