• Tutorials
• Downloads
• Referenz
• NoPaste
• FAQ

Tutorial

Guter Programmierstil

von Mao

Seite 2 von 6

Kommentare
Kommentare helfen dir, dass du dich wieder in deinen Code reinfindest, auch wenn er schon einen Monat alt ist. Natürlich kommt es dabei darauf an, dass du die relevanten Dinge kommentierst. Aber nicht nur dir, sondern auch anderen können die Kommentare helfen. Wenn du deinen Code zum Beispiel öffentlich zugänglich machst, werden sich mehrere Leute diesen wahrscheinlich ansehen und versuchen, zu verstehen wie dein Programm arbeitet. Das gilt übrigens auch für Boards, in denen guter Programmierstil allgemein wichtig ist, wenn du Hilfe bei einem Problem brauchst. Doch es gibt noch einen (schon angesprochenen) Fall. Und zwar den, dass du in einem Team arbeitest. Deine Team-Kollegen werden eine wesentlich höhere Einarbeitungszeit haben, wenn du keine Kommentare verwendest. Sinnvolle Kommentare werden ihnen helfen, deinen Code besser zu verstehen. Und das spart Zeit, welche in das gemeinsame Projekt gesteckt werden kann! :)

Allgemein, falls du das noch nicht wissen solltest (kann ja vorkommen ;): Kommentare werden vom Compiler nicht beachtet und einfach übersprungen.

In FreeBasic kann man Kommentare auf zwei verschiedene Art und Weisen machen: einmal mit REM

oder, viel lieber so:

Zum Einen ist letztere Variante kürzer, als die mit Rem (Steht übrigens für Remark ;), zum Anderen erkennt man hier auch schneller, dass es sich nicht um einen Befehl, wie zum Beispiel If handelt.
Kommentare können natürlich auch nach Code gesetzt werden:

Kommentare können jedoch vielfältig eingesetzt werden: Am Beginn eines Moduls kann der Programmierer einen kurzen, allgemeinen Überblick über selbiges geben, Credits bekannt machen, eine ToDo-List hineinschreiben und Ähnliches. Dazu ein einfacher Standard-Header:

Natürlich kann man noch viel, viel mehr Informationen in einen solchen Header hineinpacken - dieser hier soll bloß einen Anreiz bieten.
Kommentare werden zudem für die Gliederung des Quelltextes verwendet und um am Anfang von Methoden einen kurzen Überblick über diese zu geben. Hierzu ein Beispiel einer Funktion für die Berechnung der Kreisfläche:

Genauso gut werden auch Hinweise eingetragen, welche Dinge noch zu erledigen sind (siehe Stückchen weiter oben). Auch hier lässt sich das wieder am gleichen Beispiel demonstrieren:

Diese Möglichkeit wird recht häufig für Sub's verwendet (eher weniger für Funktionen), welche bestimmte unwichtigere Dinge erledigen, die vom Hauptproblem ersteinmal ablenken würden. Um aber eben dieses Hauptproblem fertig gelöst zu haben, wenn man sich an solche nebensächliche Dinge macht, kann man einfach nur einen solchen Rumpf verwenden und eintragen, was noch unbedingt gemacht werden muss. Als Beispiel gelte hier auch einmal eine Highscore-Liste in einem Spiel - diese wird meist zuletzt erledigt, trotzdem wird sie im Spielfluss schon verankert.
And last but not least helfen Kommentare auch beim Debuggen. Mit ihnen kann man vorrübergehend Code-Teile auskommentieren, um einen Bug einzukreisen. Verständlich: Wenn man einen Fehler sucht, will man wissen, wo dieser ist. Man wird natürlich nicht den Quellcode Stück für Stück löschen wollen, um ihn später wieder Stück für Stück zu schreiben. ;)

Beim Kommentieren sollte man jedoch immer Eines im Auge behalten: "Kommentiere nicht das Offensichtliche, sondern das Unsichtbare!". Ein Kommentar wie

bringt in 99,9% aller Fälle überhaupt nix. Dagegen wäre

schon viel sinnvoller. Es kommentiert das "Unsichtbare".

Gehe zu Seite  1  2  3  4  5  6  

Zusätzliche Informationen und Funktionen
Das Tutorial wurde am 08.06.2007 von Mao angelegt. Die aktuellste Version wurde am 25.09.2009 von Sebastian gespeichert.	Bearbeiten     Versionen