Quelltext der Seite Ruby/Sprache/Kommentar


== Kommentare, Retter der Verständlichkeit ==

Wer hat sie nicht schonmal gesehen? Riesige Scripte mit erschlagend viel Code, schwer zu verstehen. Wie soll man nun wissen, was sich Herr Programmierer/Frau Programmiererin bei gedacht hat?

Zur Lösung hat so ziemlich jede mir bekannte Sprache die Möglichkeit, Texte zu kommentieren, sogar brainfuck (siehe Wikipedia) hat dies. Anders als bei C-artigen Sprachen, die Kommentare durch ein "//" einleiten, nutzt Ruby das "#". Alles was rechts vom "#" steht, wird vom Rubyinterpreter ignoriert, man kann also schön erklären, was der Code an der Stelle macht.
<source lang="ruby">#Hier mal ein Beispiel
def methode(a,b)
  #Dies ist eine höhst unsinnige Methode, die a+b zurückgibt
  return(a+b)
end
=begin
Hier steht nun viel Mist.
blabla...
blubb...
system("format c")
lalala...
=end
</source>
Hier im Code fällt der "=begin;=end"-Block auf. Dies ist ein s.g. Blockkommentar, der geht über mehrere Zeilen hinweg. Also vergleichbar mit dem "/*;*/" in den C-Sprachen.



== Zu beachten ==

Kommentare sind zwar nützlich und machen den Code verständlicher, jedoch gibt es Kommentare, die man sich besser spart, da sie entweder verwirren, oder den Effekt haben, dass man vor lauter Kommentar den Code nicht mehr sieht. Beispiele für zu viel Kommentar wären der Beispielcode oben oder das SDK.