Wie man in Ruby kommentiert

An der einen oder anderen Stelle befindet sich jeder Entwickler in einer Situation, in der er den Quellcode eines Skripts ändern muss. Ohne ordnungsgemäße Dokumentation und Informationen, um Sie zu führen, wird dies nahezu unmöglich. Hier kommt das Konzept, Ihren Code zu kommentieren.

Kommentare sind einfach Informationen, die zum Quellcode eines Programms für Dokumentationszwecke hinzugefügt wurden. Sprachdolmetscher und Compiler ignorieren Kommentare. Obwohl die Hauptverwendung von Kommentaren darin besteht, die Vorgänge eines Codeblocks zu dokumentieren und zu beschreiben, können sie beim Debuggen Ihres Codes bequem sein.

In diesem Tutorial lernen wir verschiedene Möglichkeiten, Code in Ruby -Skripten zu kommentieren.

Grundnutzung: Einzelzeilenkommentare

Es gibt verschiedene Arten von Kommentaren in Ruby. Die grundlegendste ist jedoch ein einzelner Zeilenkommentar.

Es beginnt mit einem Pfundsymbol (#) und setzt sich bis zum Ende der Linie fort.

# Ruby Single -Line -Kommentar
Druck "Hallo von Ruby!"

Wie Sie im obigen Beispiel sehen können, beginnt der einzelne Zeilenkommentar mit dem Pfundsymbol und erstreckt sich bis zum Ende der Zeile.

Der Ruby -Interpreter ignoriert den Text in dem einzelnen Zeilenkommentar, auch wenn er einen gültigen Ruby -Code trägt.

Ein einzelner Zeilenkommentar in Ruby kann am Anfang einer Zeile oder am Ende beginnen, wie unten gezeigt:

Druck "Hallo von Ruby!" # Ruby Single -Line -Kommentar

In diesem Fall wird der Inhalt vor dem Pfund (#) Zeichen als gültiger Ruby -Code gezählt, während der Inhalt danach nicht ist.

Block/Multi-Line-Kommentare

In anderen Fällen müssen Sie beschreiben, was der Code auf detailliertere Weise tut. Um Kommentare einzugeben, die mehrere Zeilen in Ruby umfassen, implementieren wir Blockkommentare.

Es gibt zwei Möglichkeiten, Blockkommentare in Ruby zu implementieren:

1: = begin/= Ende

Diese Methode verwendet das Format = Beginn und = Endformat, um die Zeilen im Block als Kommentare einzuschließen.

Hier ist ein Beispiel:

= Beginnen Sie
Dies ist ein Kommentar
Das umfasst mehrere Zeilen
und es ist sehr nützlich für detaillierte Dokumentation
= Ende
Drucken "Hi Block Kommentare!"

In dieser Art von Kommentar verwenden wir zunächst das Schlüsselwort = beginne, gefolgt von allen Zeilen, die wir kommentieren möchten, und schließen mit = Ende.

Die Verwendung dieses Kommentarformats ist selten, da es bei der Formatierung der Kommentare nicht viel Flexibilität bietet und es sehr unleserlich ist.

2: Mehrere Pfundsymbole (#)

Die häufigste Möglichkeit, mehrere Zeilen in Ruby zu kommentieren.

Hier ist ein Beispiel:

# Dies ist eine weitere Kommentarmethode
# Das umfasst mehrere Zeilen
# und es ist sehr nützlich für detaillierte Dokumentation

In diesem Fall haben wir mehrere Zeilen kommentiert. Mit modernen Editoren können Sie einen Codeblock hervorheben und ihn sofort aus kommentieren.

Kommentare & magische Kommentare

Ruby ist eine interessante Sprache, weil sie magische Kommentare anbietet. Magische Kommentare nehmen ein Format an, das den regulären Kommentaren ähnelt, aber anstatt vom Dolmetscher ignoriert zu werden, ändern sie das Verhalten des Interpreters.

Magische Kommentare enthalten Ruby -Richtlinien, die definieren, was an dem Dolmetscher geändert werden soll.

Das folgende Beispiel zeigt einen magischen Kommentar zur Änderung der Codierung für String -Literale.

# Codierung: UTF-8

Obwohl das obige ähnlich wie ein regulärer Kommentar ähnelt, enthält es eine Rubinanerkennung Richtlinie.

Um mehr über Magic Comment -Richtlinien zu erfahren, betrachten Sie die Ruby Comments -Dokumentation.

Zusammenfassung

In diesem schnellen Leitfaden wurden verschiedene Arten von Ruby -Kommentaren besprochen, einschließlich der Implementierung dieser mit Leichtigkeit.