Was sind Kommentare in Ruby?
Ein Ruby-Kommentar fügt Ihrem Code Informationen hinzu, die für Sie oder andere Entwickler hilfreich sein können.
Der häufigste Kommentartyp ist der einzeilige Kommentar.
Hier ist die Syntax:
# I like apples & oranges
Beachten Sie drei Dinge:
- Der Kommentar beginnt mit einem Pfund (
#) Symbol - Wir setzen ein Leerzeichen zwischen den Inhalt des Kommentars & der Anfang des Kommentars, um das Lesen zu erleichtern
- Alles im Kommentar wird nicht als Code interpretiert, auch wenn es wie Code aussieht. Dies bedeutet, dass Sie Code vorübergehend auskommentieren können, um ihn zu deaktivieren.
Sie können diese Kommentare einzeln oder inline am Ende einer Codezeile verwenden.
.size # get array size
Gibt es andere Arten von Kommentaren?
Ja, es gibt magische Kommentare, mehrzeilige Kommentare & ERB-Kommentare.
Lassen Sie uns diese erkunden!
Verwendung von mehrzeiligen Kommentaren in Ruby
In Ruby führen wir mehrzeilige Kommentare mit regulären einzeiligen Kommentaren durch.
Manche Leute nennen diese „Kommentare blockieren“.
Hier ist ein Beispiel:
# aaa# bbb# ccc
Genau so kommentieren Sie einen Codeblock in Ruby aus.
Mit modernen Code-Editoren können Sie einen Codeblock & auswählen und alles über eine Tastenkombination kommentieren, sodass kein zusätzlicher Aufwand erforderlich ist.
Aber es gibt eine spezielle mehrzeilige Kommentarsyntax.
Es sieht so aus:
=beginThis is a comment...abc=end
Niemand benutzt diese Syntax …
Es ist hässlich & Sie können es nicht einmal in etwas verwenden, das eingerückt ist (wie eine Methode), aber es ist gut zu wissen, dass es existiert, wenn Sie es jemals in freier Wildbahn finden.
SheBang Kommentare
Ein Shebang (#!) ist eine spezielle Art von Kommentar, der einer Unix-Shell (wie bash) mitteilt, wie diese Datei zu interpretieren ist.
Wenn Sie diesen Kommentar oben in Ihrer Datei hinzufügen …
können Sie Ihre Ruby-Dateien als ausführbare Dateien ausführen, vorausgesetzt, sie haben die richtigen Berechtigungen dafür.
So sieht ein Shebang-Kommentar aus:
#!/usr/bin/env ruby
Auf diese Weise können Sie auch bestimmte Befehlszeilenoptionen festlegen, z. B. die Warnoption.
Beispiel:
#!/usr/bin/env ruby -w
Jedes Mal, wenn Sie diesen Code ausführen, werden diese Optionen ausgeführt, sodass Sie sie nicht manuell übergeben müssen.
Verwendung magischer Kommentare
Ein magischer Kommentar ändert das Verhalten des Ruby-Interpreters in irgendeiner Weise.
Beispiel:
Der Kommentar frozen_string_literals lässt Ihre Zeichenfolgen standardmäßig einfrieren.
Es sieht so aus:
# frozen_string_literal: true
Mit einem weiteren magischen Kommentar können Sie die Kodierung der Datei ändern.
Hier ist ein Beispiel:
# encoding: utf-8
A hier ist ein interessanter, der warn_indent Kommentar:
# warn_indent: true
Dies zeigt eine Warnung an, wenn Ihre Einrückung falsch ist.
Beispiel:
def comments end
Was zu:
warning: mismatched indentations at 'end' with 'def' at 3
ERB-Kommentare
Wenn Sie ERB für Ihre Rails-Ansichten verwenden & müssen Sie einen Kommentar hinzufügen …
Dann können Sie diese Syntax verwenden:
Ich bin kein großer Fan davon, weil ich glaube, dass Sie den größten Teil Ihrer Logik aus Ihren Ansichten heraushalten sollten, damit Sie keine Kommentare benötigen.
Möchten Sie Code zum Debuggen deaktivieren?
Löschen Sie dann diesen Code & vertrauen Sie git oder einem anderen Versionskontrollsystem, das Sie verwenden.
Zusammenfassung
