Verwenden von Kommentaren in Ruby

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 in der Regel 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 liefern oder schwierigen Code zu kommentieren. Notizen, die lediglich angeben, was die nächste Zeile des einfachen Codes bewirkt, sind nicht nur offensichtlich, sondern sorgen auch für mehr Unordnung in der Datei.

Es ist wichtig, darauf zu achten, dass nicht zu viele Kommentare verwendet werden und 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 nennt man a shebang und wird 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 du vielleicht auch siehst #! / usr / bin / ruby oder #! / usr / local / bin / ruby.

Einzeilige Kommentare

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

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

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) # Gib die Summe von 10 und 20 aus 

Mehrzeilige Kommentare

Ruby wird von vielen Ruby-Programmierern oft vergessen, enthält jedoch mehrzeilige Kommentare. Ein mehrzeiliger Kommentar beginnt mit dem = beginne Token und endet mit dem = Ende Zeichen.

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

 #! / usr / bin / env ruby

 = beginne

 Zwischen = begin und = end eine beliebige Zahl

 Zeilen können geschrieben werden. Alle von denen

 Zeilen werden vom Ruby-Interpreter ignoriert.

 = Ende

 setzt "Hallo Welt!"

In diesem Beispiel würde der Code ausgeführt als Hallo Welt!