Computerwissenschaften

Kommentare für Ruby-Code (Verwendung, einzeilig und mehrzeilig)

Kommentare in Ihrem Ruby- Code sind Notizen und Anmerkungen, die von anderen Programmierern gelesen werden sollen. Die Kommentare selbst werden vom Ruby-Interpreter ignoriert, sodass der Text in den Kommentaren keinen Einschränkungen unterliegt.

Es ist normalerweise eine gute Form, Kommentare vor Klassen und Methoden sowie vor Code zu setzen, der komplex oder unklar sein kann.

 

Kommentare effektiv nutzen

Kommentare sollten verwendet werden, um Hintergrundinformationen zu geben oder schwierigen Code zu kommentieren. Notizen, die einfach sagen, was die nächste Zeile einfachen Codes bewirkt, sind nicht nur offensichtlich, sondern fügen der Datei auch Unordnung hinzu.

Es ist wichtig, nicht zu viele Kommentare zu verwenden und sicherzustellen, dass die in der Datei enthaltenen Kommentare für andere Programmierer aussagekräftig und hilfreich sind.

 

Der Shebang

Sie werden feststellen, dass alle Ruby-Programme mit einem Kommentar beginnen, der mit # beginnt ! . Dies wird als Shebang bezeichnet und auf Linux-, Unix- und OS X-Systemen verwendet.

Wenn Sie ein Ruby-Skript ausführen, sucht die Shell (z. B. Bash unter Linux oder OS X) in der ersten Zeile der Datei nach einem Shebang. Die Shell verwendet dann den Shebang, um den Ruby-Interpreter zu finden und das Skript auszuführen.

Der bevorzugte Ruby Shebang ist #! / Usr / bin / env ruby , obwohl Sie möglicherweise auch #! / Usr / bin / ruby oder #! / Usr / local / bin / ruby ​​sehen .

 

Einzeilige Kommentare

Der einzeilige Ruby-Kommentar beginnt mit dem Zeichen # und endet am Ende der Zeile. Alle Zeichen vom Zeichen # bis zum Ende der Zeile werden vom Ruby-Interpreter vollständig ignoriert.

Das Zeichen # muss nicht unbedingt am Zeilenanfang stehen. es kann überall auftreten.

Das folgende Beispiel zeigt einige Verwendungszwecke von Kommentaren.


 #! / usr / bin / env ruby

 


 

 # Diese Zeile wird vom Ruby-Interpreter ignoriert

 


 

 # Diese Methode gibt die Summe ihrer Argumente aus

 

 def sum (a, b)

 

   setzt a + b

 

 Ende

 


 

 sum (10,20) # Gibt die Summe von 10 und 20 aus

 

Mehrzeilige Kommentare

Obwohl Ruby von vielen Ruby-Programmierern oft vergessen wird, hat es mehrzeilige Kommentare. Ein mehrzeiliger Kommentar beginnt mit dem Token = begin und endet mit dem Token = end .

Diese Token sollten am Anfang der Zeile beginnen und das einzige Element in der Zeile sein. Alles zwischen diesen beiden Token wird vom Ruby-Interpreter ignoriert.


 #! / usr / bin / env ruby

 


 

=beginne

 

 Zwischen=Anfang und=Ende eine beliebige Zahl

 

von Zeilen kann geschrieben werden. Alle von denen

 

 Zeilen werden vom Ruby-Interpreter ignoriert.

 

=Ende

 


 

 setzt "Hallo Welt!"

In diesem Beispiel würde der Code als Hello world!

Similar Posts

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.