Gute Programmiertechniken

Kommentare

Ein Kommentar ist Text, der mit dem Symbol # beginnt. Kommentare werden von Ruby ignoriert. Zum Beispiel:


#!/usr/bin/ruby

# Such die größte Potenz von 2, die 
# kleiner als 10000 ist
zahl = 1
while zahl < 10_000
  zahl*= 2
end
zahl /= 2

Der Kommentar hilft Ihnen dabei, sich zu erinnern, was ihr Code macht.

Wie man Kommentare nutzt:

Schreiben Sie für jeden Schritt ihres Programms einen verständichen Kommentar.
Erklären Sie, was ihr Code macht, nicht wie es gemacht wird. Wenn das wie nicht offensichtlich ist aus dem Kommentar, dann müssen Sie Ihren Code dahingehend ändern.
Schreiben Sie im Zweifel mehr Kommentare, nicht weniger.

Einrückung

Rücken Sie Ihren Code immer ein.

Wenn Sie es nicht tun, wird Ihr Code unlesbar und Sie werden es nie hinbekommen, irgendwas zu schreiben als das simpelste Programm.

Gut

Schlecht


# Addiere ungerade Zahlen
zahl, summe = 1, 0
while zahl < 100
    # % ist 'Rest nach Division'
    if zahl % 2 == 1
        sume +=zahl
    end
    puts summe
end


# Addiere ungerade Zahlen
zahl, summe = 1, 0
while zahl < 100
# % ist 'Rest nach Division'
if zahl % 2 == 1
summe += zahl
end
puts summe
end

While-Schleifen

Thema dieses Kapitels